Skip to main content
POST
Send a campaign message
Use an API key with Send campaign messages and access to this campaign. The response includes the request ID and camelCase pricing fields. The request is rate limited. Honor Retry-After on retryable failures. See Campaigns API for lifecycle and charging.

Authorizations

Authorization
string
header
required

An API key (tars_sk_…) sent as Authorization: Bearer <key>. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.

Path Parameters

id
string
required

The id.

Required string length: 1 - 128

Body

application/json

One webhook campaign message.

to
string
required

The recipient in international format.

params
object

Template parameters by name.

media
object

Media for the template's media header.

Response

The message was sent.

The message was sent and charged.

status
any
required
quotedUsd
number
required

What the send cost in US dollars.

requestId
string
required

The request id (req_…). Quote it when you contact support.

balance
number

The credit balance in US dollars after the charge.

externalMessageId
string

The provider's message id, when it returned one.