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])?$

Path Parameters

task_id
string<uuid>
required

Large task identifier.

Body

application/json

The body is of type object.

Response

Task state returned. Submission is not delivery or completion.

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)$
kind
enum<string>
required
Available options:
calls,
sms
recipient_format
enum<string>
required
Available options:
contact_ids,
recipients
status
enum<string>
required
Available options:
uploading,
queued,
processing,
completed,
failed
total_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
uploaded_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
submitted_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
settled_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
failed_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
unknown_recipients
integer
required
Required range: 0 <= x <= 9007199254740991
total_parts
integer
required
Required range: 0 <= x <= 9007199254740991
submitted_parts
integer
required
Required range: 0 <= x <= 9007199254740991
failed_parts
integer
required
Required range: 0 <= x <= 9007199254740991
error_code
string | null
required
upload_chunk_size
integer
required
Required range: 1 <= x <= 1000
created_at
string
required