Skip to main content
PATCH
/
v1
/
broadcasts
/
{broadcastId}
Update broadcast
curl --request PATCH \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "text": "<string>",
  "content": {
    "mediaUrl": "<string>",
    "mediaId": "<string>",
    "mimeType": "<string>",
    "filename": "<string>",
    "templateId": "<string>",
    "templateVariables": {}
  },
  "emailSubject": "<string>",
  "emailHtmlBody": "<string>",
  "metadata": {}
}
'
{
  "broadcast": {
    "id": "brd_abc123",
    "name": "<string>",
    "status": "draft",
    "channel": "smart",
    "messageType": "text",
    "totalContacts": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "text": "<string>",
    "content": {
      "mediaUrl": "<string>",
      "mediaId": "<string>",
      "mimeType": "<string>",
      "filename": "<string>",
      "templateId": "<string>",
      "templateVariables": {}
    },
    "senderId": "<string>",
    "emailSubject": "<string>",
    "pendingCount": 123,
    "sendingCount": 123,
    "deliveredCount": 123,
    "failedCount": 123,
    "estimatedCost": 123,
    "reservedAmount": 123,
    "actualCost": 123,
    "scheduledAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "metadata": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

broadcastId
string
required

Body

application/json
name
string
text
string
content
object

Content for non-text broadcast message types.

emailSubject
string
emailHtmlBody
string
metadata
object

Response

Broadcast updated.

broadcast
object
required