Send messages

post

https://api.sintalk.com.br/v3/messages

Send one body to many recipients in a single request. The body is either inline content (channel + content) or a saved template (template_id); its channel applies to the whole batch, and each entry in recipients carries its own destination and its own variables, substituted into the body for that recipient alone.

The response carries one result per recipient, in request order, each with the message id created for it and the status it was created with. A mixed outcome is normal:

pending — accepted and queued for dispatch.
blocked — the recipient is suppressed on this channel, so it was never dispatched and was not charged.
error — it never reached a carrier: no sender configured for the channel, referenced media unavailable, a variable the body references missing for that recipient, or a body that rendered empty.

Only pending results go on to a carrier; the other two are already terminal. Send an Idempotency-Key to make a retry safe: replaying the key returns the original results instead of sending — and charging — a second time.

Body Params

A batch send: one body — inline content or a saved template — rendered per recipient and delivered over its channel.

body

required

What to send: inline content or a saved template reference.

InlineContent
TemplatedContent

campaign_id

uuid

Campaign to attribute every message this request creates to, so the send shows up under the campaign_id list filter. Must be a campaign of yours; an unknown id is rejected with 404. Omit it for an ad-hoc send.

recipients

array of objects

required

length between 1 and 50000

Recipients of this batch, 1 to 50000. Each yields its own message, its own result entry, and its own charge.

recipients*

Headers

Idempotency-Key

string

length ≤ 255

A client-generated key that makes this request safe to retry. Replaying a key returns the original response instead of repeating the write, so a timeout or a network failure cannot send twice or charge twice. Reusing a key with a different request body is refused with 409 conflict. Keys are scoped to your account and retained for 24 hours.

Responses

202Batch accepted: one result per recipient, with the message id created for it and its initial status. Accepted means queued, not delivered.

400The request was rejected before it was applied — either a field failed validation (validation_failed, with error.fields naming each one), or the request could not be read at all (bad_request: malformed JSON, an unknown field, a missing parameter, or an unparseable path or query value).

401No credential was presented, or the one presented was rejected.

403The credential is valid but is not allowed to call this operation.

404No resource with that id exists in your account. An id belonging to another account is reported the same way as one that never existed.

409The request collides with what already exists, or with the resource's current state. Re-read the resource before retrying.

422The body parsed and every field is individually valid, but the request cannot be applied as asked. Retrying it unchanged will fail again.

429Rate limit exceeded

defaultAn unexpected error. Safe to retry with backoff; use an idempotency key where the operation accepts one.