TEASEDocs
API ReferenceInbox & Broadcasts

Create a broadcast campaign

Creates a draft broadcast campaign in one of four modes (segmented, tiered, drip-with-auto-stop, online_trigger). Sends are screened, paced, and behind an off-by-default delivery gate; creating a campaign does not deliver anything. Requires a write-scoped key.

Authorization

bearerAuth
AuthorizationBearer <token>

Your al_live_<prefix>_<secret> API key. Mint and manage keys in the dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

POST
/api/admin/broadcasts
curl -X POST "https://example.com/api/admin/broadcasts" \  -H "Content-Type: application/json" \  -d '{    "title": "Weekend whale push",    "mode": "tiered",    "audience": {      "tier": "whales",      "status": "active"    },    "message": {      "text": "miss you 💕 unlock my new set",      "media_ids": [        "med_771"      ],      "price_cents": 2500    },    "schedule": {      "start_at": 1719849600    },    "operator_id": 7,    "of_account_id": "acct_92f1"  }'
{  "id": 42}
{  "detail": "Not authenticated"}
{  "detail": [    {      "loc": [        "body",        "title"      ],      "msg": "ensure this value has at least 1 characters",      "type": "value_error.any_str.min_length"    }  ]}

List broadcast campaigns

Returns all mass-messaging campaigns (broadcasts) for your account. Requires a read-scoped key.

Preview a broadcast audience

Estimates how many fans an audience selector matches before scheduling, returning matched/selected counts and a non-PII distribution. Does not create or send anything. Requires a read-scoped key.