Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

Your API key, e.g. gr_live_…

Headers

Idempotency-Key
string
required

Your own unique id for this request (at most 255 characters). The same id and body within 24 hours answers the first answer again — never a second send or charge.

Maximum string length: 255

Body

application/json
name
string
required
template
object
required
audience
object
required

Exactly one of numbers, tag or saved_audience.

reference
string
Maximum string length: 512
values
object

The template's variables: body, header and buttons.

header_media
object
send_at
string<date-time>

When to send (ISO 8601). Leave out to send now.

Response

Created: who goes, who was skipped and why, and the cost by country.

id
string
status
string
people
integer
skipped
object
cost
object
reference
string | null