Add Recipients Route

POST

/platform/v1/broadcasts/{broadcast_id}/recipients

curl --request POST \
  --url https://example.com/platform/v1/broadcasts/1/recipients \
  --header 'Content-Type: application/json' \
  --data '{ "recipients": [ { "to": "example", "variables": {} } ] }'

Add up to 1000 recipients — dedupe + per-plan cap + per-recipient validation. Returns {added, duplicates, errors[]}.

Errors: * 404 — broadcast not found / not owned. * 409 status_locked — broadcast is not in draft.

Parameters

Path Parameters

broadcast_id

required

Broadcast Id

integer

Request Body ^required

Media type application/json

PlatformAddRecipients

object

recipients

required

Recipients

Array<object>

>= 1 items <= 1000 items

RecipientIn

object

to

required

To

string

>= 1 characters <= 64 characters

variables

Variables

object

key

additional properties

any

Example ^generated

{
  "recipients": [
    {
      "to": "example",
      "variables": {}
    }
  ]
}

Responses

200

Successful Response

Media type application/json

PlatformAddRecipientsResponse

object

added

required

Added

integer

duplicates

required

Duplicates

integer

errors

required

Errors

Array<object>

object

key

additional properties

any

Example ^generated

{
  "added": 1,
  "duplicates": 1,
  "errors": [
    {}
  ]
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}