Add contacts to broadcast

POST

broadcasts

{broadcastId}

contacts

curl --request POST \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contacts": [
    {
      "recipient": "+14155551234",
      "templateVariables": {
        "name": "John",
        "order_id": "ORD-001"
      }
    },
    {
      "recipient": "+14155555678",
      "templateVariables": {
        "name": "Jane",
        "order_id": "ORD-002"
      }
    }
  ]
}
'

{
  "added": 123,
  "duplicates": 123,
  "invalid": 123,
  "errors": [
    {
      "recipient": "<string>",
      "reason": "<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

Body

application/json

contacts

object[]

required

List of contacts to add (max 1000 per request).

Maximum array length: 1000

Show child attributes

Response

Contacts added.

added

integer

required

Number of contacts successfully added.

duplicates

integer

required

Number of duplicate contacts skipped.

invalid

integer

required

Number of invalid contacts rejected.

errors

object[]

Details about invalid contacts.

Show child attributes

List broadcast contacts

Remove contact from broadcast

⌘I

Add contacts to broadcast

curl --request POST \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contacts": [
    {
      "recipient": "+14155551234",
      "templateVariables": {
        "name": "John",
        "order_id": "ORD-001"
      }
    },
    {
      "recipient": "+14155555678",
      "templateVariables": {
        "name": "Jane",
        "order_id": "ORD-002"
      }
    }
  ]
}
'

{
  "added": 123,
  "duplicates": 123,
  "invalid": 123,
  "errors": [
    {
      "recipient": "<string>",
      "reason": "<string>"
    }
  ]
}