Skip to main content
GET
Status of a previously scheduled bulk broadcast
Returns the status of a broadcast created by POST /v1/messages/bulk.

Endpoint

Required scope

messages:bulk

Headers

Path params

Example request

Response

200 OK

400 Bad Request

broadcastId is not a valid ObjectId.

404 Not Found

The broadcast does not exist or belongs to another tenant.

401 / 403

Standard auth and scope errors.

Polling pattern

To wait for a broadcast to finish from your integration:
Every poll costs one request against your 1,000/day quota, so polling every 5s for an hour would spend 720 of it. Poll every 30s for large campaigns, and stop as soon as the status is terminal.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Path Parameters

broadcastId
string
required

Response

200 - application/json
broadcast_id
string
required
status
string
required
total_recipients
number
required
sent
number
required
failed
number
required
pending
number
required
started_at
string | null
completed_at
string | null