Send broadcast

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

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "insufficient_balance",
  "message": "Insufficient balance. Available: $50.00",
  "details": {
    "totalBalance": 50,
    "reservedBalance": 25,
    "availableBalance": 25
  }
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

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

Remove contact from broadcast

Reschedule broadcast

⌘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
  }
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "insufficient_balance",
  "message": "Insufficient balance. Available: $50.00",
  "details": {
    "totalBalance": 50,
    "reservedBalance": 25,
    "availableBalance": 25
  }
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}