Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Use a server-side Brightalk API key in the Authorization header.

Headers

Brightalk-Version
string
default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned default.

Allowed value: "2026-07-16"
X-Request-Id
string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64
Pattern: ^[A-Za-z0-9._:-]{1,64}$
Idempotency-Key
string
required

A nonsecret key retained for 24 hours. Reuse only for a semantically identical request.

Required string length: 1 - 255
Pattern: ^(?=.{1,255}$)[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$

Body

application/json
message
string
required

Final carrier text, including prefixes, resolved variables and the final short URL, must fit the SMS segment policy. The 2000-character request limit is not a carrier allowance.

Required string length: 1 - 2000
recipients
object[]
required
Required array length: 1 - 1000 elements
metadata
object
reference_id
string
Required string length: 1 - 255
external_id
string
Required string length: 1 - 255
webhook
object
schedule
object
test_mode
boolean
expires_at
string
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$

Response

Successful response.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
scheduled,
processing,
completed
total_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
completed_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
messages
object[]
required
Maximum array length: 1000
metadata
object
required
reference_id
string | null
required
external_id
string | null
required
test_mode
boolean
required
created_at
string
required
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$