Automations · Broadcasts
Updates a broadcast. Fields you leave out keep their current values.
PATCH
https://api.pozy.ai/v1/broadcasts/{broadcastId}updateBroadcast
Guides: Broadcasts, WhatsApp broadcasts
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
broadcastIdrequired | string |
Request body
application/json, optional
namestringdescriptionstringmessageobjecttextstringattachmentsarray of objectUp to 10 items.
3 child fields
typestringurlstringfilenamestring
messageTagstringOne of
CONFIRMED_EVENT_UPDATE,POST_PURCHASE_UPDATE,ACCOUNT_UPDATE,HUMAN_AGENT.
templateobjectnamestringlanguagestringvariableMappingmap of objectKeys are free-form; each value has these fields.
2 child fields
fieldstringOne of
name,phone,email,company,custom.customValuestring
segmentFiltersobject
Example
curl -X PATCH "https://api.pozy.ai/v1/broadcasts/6ce1988a4c4f8bc6d3ca157a" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme",
"description": "A short description",
"message": {
"text": "Hello from Pozy",
"attachments": [
{
"type": "string",
"url": "https://pozy.ai/media/example-1.jpg",
"filename": "photo.jpg"
}
],
"messageTag": "CONFIRMED_EVENT_UPDATE"
},
"template": {
"name": "Acme",
"language": "en",
"variableMapping": {
"key": {
"field": "name",
"customValue": "string"
}
}
}
}'const res = await fetch("https://api.pozy.ai/v1/broadcasts/6ce1988a4c4f8bc6d3ca157a", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Acme",
description: "A short description",
message: {
text: "Hello from Pozy",
attachments: [
{
type: "string",
url: "https://pozy.ai/media/example-1.jpg",
filename: "photo.jpg"
}
],
messageTag: "CONFIRMED_EVENT_UPDATE"
},
template: {
name: "Acme",
language: "en",
variableMapping: {
key: {
field: "name",
customValue: "string"
}
}
}
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.patch(
"https://api.pozy.ai/v1/broadcasts/6ce1988a4c4f8bc6d3ca157a",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"name": "Acme",
"description": "A short description",
"message": {
"text": "Hello from Pozy",
"attachments": [
{
"type": "string",
"url": "https://pozy.ai/media/example-1.jpg",
"filename": "photo.jpg",
},
],
"messageTag": "CONFIRMED_EVENT_UPDATE",
},
"template": {
"name": "Acme",
"language": "en",
"variableMapping": {
"key": {
"field": "name",
"customValue": "string",
},
},
},
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanbroadcastobjectidstringnamestringdescriptionstringstatusstringupdatedAtstring (date-time)
200 response
{
"success": true,
"broadcast": {
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"description": "A short description",
"status": "active",
"updatedAt": "2026-10-02T09:00:00.000Z"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.