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

JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.

contact_id
string
required
Required string length: 1 - 255
message
string
required

Literal text, up to 5000 UTF-16 code units. An emoji outside the BMP counts as two units. Whitespace-only text is rejected.

Required string length: 1 - 5000
Pattern: \S

Response

LINE send receipt created or replayed. Inspect status; creation is not delivery.

id
string
required
Required string length: 1 - 255
contact_id
string
required
Required string length: 1 - 255
status
enum<string>
required

sent is provider acceptance, never delivery or read. pending and unknown must not trigger another send.

Available options:
pending,
sent,
failed,
unknown
error_code
enum<string> | null
required
Available options:
null,
module_unavailable,
credentials_unavailable,
authorization_changed,
provider_rejected,
delivery_unconfirmed,
dispatch_not_started
created_at
string<date-time>
required