Skip to main content
POST
Queue template send job
Accepts a bulk template send and processes it in the background. The request is validated at the door, queued durably, and returns 202 Accepted immediately with a job id. Send an Idempotency-Key header to make retries safe: repeats of the same key within seven days return the original job id instead of sending the batch again. Without the header, Flowella derives a key from the request body, so an identical batch submitted twice in quick succession is not double-sent. Recipients are processed individually, so one invalid number does not block the rest of the batch.

Authorizations

Authorization
string
header
required

Organization API key (flo_…). Paste the full key; Scalar sends Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Unique key (up to 200 characters) identifying this batch. Repeats of the same key within seven days return the original job id without re-sending. If omitted, Flowella derives a key from the request body.

Maximum string length: 200

Body

application/json
templateId
string
required
Required string length: 1 - 128
whatsappChannelId
string<cuid>
required
recipients
object[]
required
Required array length: 1 - 50000 elements
templateWabaId
string
Minimum string length: 1
headerMedia
object

Media card carousel parameters. Send one entry per template card, in card order. The same card media, card body values, and button values are used for every recipient. If a card has no mediaUrl or mediaId, Flowella sends that card's approved sample media.

Required array length: 2 - 10 elements
scheduledAt
string | null
throttlePerHour
integer
Required range: 1 <= x <= 100000

Response

Request accepted for durable processing

id
string
required
status
enum<string>
required
Available options:
accepted