API Reference

Send broadcast

Start sending the broadcast immediately or schedule for later.

Sending a broadcast needs no account verification. Identity and business verification raise daily ceilings; neither is a permission to broadcast, on any channel. What stands in front of a broadcast is the content review below, and it applies to every send path — dashboard, API and CLI. Drafts can be created, edited and kept freely.

Daily ceilings apply per recipient. Each message a broadcast sends counts against the channel’s daily ceiling (see POST /v1/messages). Once the ceiling is reached, the remaining recipients are marked failed with errorCode DAILY_LIMIT_EXCEEDED; they are not retried the next day.

Review depends on the channel, and cannot be bypassed. A draft is submitted to automated content review here; it does not go straight out. A WhatsApp broadcast built on a Meta-approved template skips review (Meta already vetted the content) and begins sending. An email broadcast sends as soon as the review passes it, unless the review asks for a person. Every other channel moves to pending_admin_review and waits for a person. A broadcast the review refuses lands on rejected: use PATCH to edit the content then call POST /retry-review, or escalate it for a manual review.

A broadcast is read once, on its own text, rather than per recipient. While an account’s sending is suspended its recipients fail individually with errorCode SENDING_SUSPENDED; see POST /v1/messages.

Calling this on a broadcast that is already approved or scheduled sends or reschedules it directly, since it has already been reviewed. Reserves the estimated cost from your balance.

POST

broadcasts

{broadcastId}

send

curl --request POST \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "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": {},
      "templateButtonVariables": {},
      "templateHeaderVariables": {}
    },
    "senderId": "<string>",
    "emailSubject": "<string>",
    "pendingCount": 123,
    "sendingCount": 123,
    "sentCount": 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",
    "reviewResult": {
      "score": 123,
      "categories": [
        "<string>"
      ],
      "reasoning": "<string>",
      "reviewedAt": "2023-11-07T05:31:56Z",
      "flaggedContent": [
        "<string>"
      ]
    },
    "reviewAttempts": 123
  }
}

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

scheduledAt

string<date-time>

Schedule for future delivery. Omit to send immediately.

Response

Broadcast started or scheduled.

broadcast

object

required

Show child attributes

⌘I

curl --request POST \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "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": {},
      "templateButtonVariables": {},
      "templateHeaderVariables": {}
    },
    "senderId": "<string>",
    "emailSubject": "<string>",
    "pendingCount": 123,
    "sendingCount": 123,
    "sentCount": 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",
    "reviewResult": {
      "score": 123,
      "categories": [
        "<string>"
      ],
      "reasoning": "<string>",
      "reviewedAt": "2023-11-07T05:31:56Z",
      "flaggedContent": [
        "<string>"
      ]
    },
    "reviewAttempts": 123
  }
}