Create conversations in bulk

post

https://{defaultHost}/api/v4/messaging/conversations/bulk

Initiate conversations with a WhatsApp template message for up to 500 recipients.

Processing is asynchronous: the endpoint returns a job that can be polled for per-recipient results. Request-level errors, such as an unknown template or a duplicate recipient, reject the whole request. Per-recipient failures, such as an invalid phone number, do not block other recipients and are reported in the job result.

Body Params

reference

string

length ≤ 255

Client-assigned reference for grouping related requests, such as all chunks of one campaign. Does not have to be unique.

channel_profile_id

integer

required

The unique identifier of the channel profile.

message

object

required

The initial message for every conversation.

recipients

array of objects

required

length between 1 and 500

Recipients of the bulk send.

recipients*

contact_channel_identifier

string

required

Channel-specific identifier of the contact (phone number for WhatsApp).

placeholders

object

Placeholder values for the WhatsApp template, indexed by position. Override the shared message placeholders at matching positions.

source

object

Information about the external system that provided the contact number, such as a CRM.

Headers

Idempotency-Key

string

length ≤ 255

A unique client-generated key that makes the request safe to retry. Repeating a request with the same key returns the previously created job instead of creating a new one. Reusing the key with a different request body is rejected.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted

401Unauthorized

403Forbidden

422Unprocessable Entity

429Too many requests