Skip to main content
POST
Estimate a campaign's send cost

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
channel
enum<string>
required

Channel the campaign will send on.

Available options:
sms,
mms,
whatsapp,
email,
rcs,
viber,
voice,
push,
instagram,
messenger,
line,
telegram,
fax,
kakao,
zalo,
wechat
estimated_recipients
integer
required

Number of recipients to price the send for.

Required range: 0 <= x <= 10000000
country_code
string

Destination country (ISO alpha-2, or * for the default rate). Affects per-country wholesale pricing.

sub_type
string

Message sub-type lane (e.g. WhatsApp marketing vs utility).

Maximum string length: 64

Response

200 - application/json

Estimated per-unit and total cost for the send

Estimated per-unit and total cost for the send

data
object
meta
object