Add recipients to a broadcast

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

id*string

Broadcast ID

application/json

TypeScript Definitions

Use the request body type in TypeScript.

phones?array<string>

Phone numbers in E.164 format (WhatsApp)

contact_ids?array<string>

Contact IDs to resolve platform identifiers from

identifiers?array<string>

Raw platform identifiers (IG user ID, chat ID, etc.)

curl -X POST "https://api.relayapi.dev/v1/broadcasts/string/recipients" \  -H "Content-Type: application/json" \  -d '{}'

{
  "added": 0,
  "skipped": 0
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Found something wrong? Help us improve this page.

Broadcasts

Cancel a broadcast POST