Campanhas
Campaigns: an approved template sent to an audience, with scheduling, a send window and throughput control. Sends happen in a separate process and do not spend your API key's sending limit.
List campaigns
The account's campaigns, newest first. An API key limited to some numbers only sees those numbers' campaigns.
Create a campaign
Creates a draft. Only `name` is required: number, template, variables and audience
Upload a campaign's header media
Uploads to Meta, through the campaign's number, the template header's image, video or
Get a campaign
Get a campaign
Edit a campaign
Only drafts and scheduled campaigns can be edited. Editing a scheduled campaign turns it back into a draft — it has to be launched again.
Delete a campaign
Only drafts can be deleted. For the others, archive them.
Estimate reach and cost
Checks the whole campaign and works out who it would reach right now: how many contacts,
Launch a campaign
Freezes the audience and sets the campaign to send — now, or at `scheduledAt` (up to a
Send a campaign test
Sends the campaign's template to one number, right away, outside the queue and the
Pause a campaign
Pause a campaign
Resume a campaign
Resume a campaign
Cancel a campaign
Stops the campaign for good. Whoever has not received it yet is marked skipped, with the reason `canceled`.
Duplicate a campaign
A new draft with the same setup, without the schedule.
Archive a campaign
Takes the campaign off the main list (or brings it back, with `archived: false`). A campaign in progress must be cancelled or finish first.
Resend recipients with no answer
`unknown` recipients are sends Meta never answered. They are not retried on their
Campaign metrics
Counters, rates, clicks per button, grouped failures, cost per country, delivery and
Campaign time series
Sends, deliveries, reads, clicks, failures and replies per 15-minute bucket — or 1 hour, when the campaign spans more than two days.
List recipients
List recipients
Export recipients as CSV
The recipients, with the same filters as the listing and no paging, as a CSV with a UTF-8 BOM.