Create broadcast

Changed on

Create a new broadcast campaign. Add contacts after creation, then send.

post/v1/broadcasts

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/broadcasts
  • Auth
    HTTP bearer

Request body

namestring required

Name of the broadcast campaign.

channel'smart' | 'sms' | 'sms_oneway' | 'whatsapp' | 'telegram' | 'email' required

Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.

messageType'text' | 'image' | 'video' | 'audio' | 'document' | 'template'

Type of message for broadcast.

textstring

Text content or caption. Supports template variables: {{name}}, {{1}}, etc.

senderIdstring

Sender profile ID. Uses default sender if omitted.

emailSubjectstring

Email subject line. Required for email broadcasts.

emailHtmlBodystring

HTML body for email broadcasts.

scheduledAtstring date-time

Schedule the broadcast for future delivery.

metadataobject
idempotencyKeystring

Idempotency key to prevent duplicate broadcasts.

Example request

{
  "name": "Black Friday Sale",
  "text": "Hi {{name}}, check out our Black Friday deals!"
}

Response

Broadcast created.

Example response

{
  "broadcast": {
    "id": "brd_abc123"
  }
}

Changes

    • breaking

      removed the enum value instagram of the request property

    • breaking

      removed the enum value messenger of the request property

    • breaking

      removed the enum value voice of the request property

    • info

      removed the instagram enum value from the / response property for the response status

    • info

      removed the instagram enum value from the / response property for the response status

    • info

      removed the messenger enum value from the / response property for the response status

    • info

      removed the messenger enum value from the / response property for the response status

    • info

      removed the voice enum value from the / response property for the response status

    • info

      removed the voice enum value from the / response property for the response status

    • warning

      added the new messenger enum value to the / response property for the response status

    • warning

      added the new messenger enum value to the / response property for the response status

    • info

      added the new messenger enum value to the request property