API Reference

Send broadcast

Start sending the broadcast immediately or schedule for later.

Verification is required to send, except on WhatsApp. On every channel other than whatsapp, the team must have completed both identity verification (KYC) and business verification (KYB); passing one is not enough. A whatsapp broadcast requires neither: it can only be built on a template, and Meta vets the business and the content when it approves that template, so an unapproved template is refused instead. smart is not exempt — it can route a contact to SMS or email. Drafts can be created, edited and kept without any check. Every send path — dashboard, API and CLI alike — enforces the same rule, returning 403 with code kyc_required or kyb_required for whichever is outstanding.

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 automated review passes. Every other channel moves to pending_admin_review and waits for a person. If the review rejects it, use PATCH to edit the content then call POST /retry-review.

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>",
    "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,
    "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>",
    "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,
    "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
  }
}