Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
message
string
required

The first text. {{first_name}} is replaced with each person's first name.

tag
string

Text every customer with this tag.

customer_ids
string[]

Text these customers (cus_...).

phone_number_id
string

Which business line sends the texts. Defaults to the first number with texting on.

Response

The launch: its id, how many were enrolled, and skips by reason

object
string
launch_id
string
enrolled
integer
skipped
object