Skip to main content
GET
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}$

Response

Successful response.

enabled
boolean
required
credits
number
required
sender_name
string | null
required
registration_status
string
required
Allowed value: "contact_support"
sender_number
null
required
supports_multipart
boolean
required
max_segments
number
required
credits_per_segment
number
required
supported_destination
string
required
Allowed value: "+8869XXXXXXXX"