List broadcast contacts

GET

broadcasts

{broadcastId}

contacts

curl --request GET \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "<string>",
      "recipient": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "templateVariables": {},
      "templateButtonVariables": {},
      "templateHeaderVariables": {},
      "messageId": "<string>",
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "cost": 123,
      "processedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

broadcastId

string

required

Query Parameters

status

enum<string>

Status of a contact within a broadcast.

Available options:

pending,

queued,

sending,

delivered,

failed,

skipped

limit

integer

default:50

Required range: x <= 100

cursor

string

Response

List of broadcast contacts.

items

object[]

required

Show child attributes

nextCursor

string | null

Update broadcast

Add contacts to broadcast

⌘I

List broadcast contacts

curl --request GET \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "<string>",
      "recipient": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "templateVariables": {},
      "templateButtonVariables": {},
      "templateHeaderVariables": {},
      "messageId": "<string>",
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "cost": 123,
      "processedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}