Campaigns
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.
GETList campaignsThe account's campaigns, newest first. An API key limited to some numbers only sees those numbers' campaigns.POSTCreate a campaignCreates a draft. Only name is required: number, template, variables and audience can come later, through PATCH. The campaign is only fully checked at the…POSTUpload a campaign's header mediaUploads to Meta, through the campaign's number, the template header's image, video or document. Send the file bytes as the body, with the name in…GETGet a campaignGet a campaignPATCHEdit a campaignOnly drafts and scheduled campaigns can be edited. Editing a scheduled campaign turns it back into a draft — it has to be launched again.DELDelete a campaignOnly drafts can be deleted. For the others, archive them.POSTEstimate reach and costChecks the whole campaign and works out who it would reach right now: how many contacts, how many are left out and why, the recipient cap, the plan quota,…POSTLaunch a campaignFreezes the audience and sets the campaign to send — now, or at scheduledAt (up to a year ahead). More than 60 seconds in the future, the campaign becomes…POSTSend a campaign testSends the campaign's template to one number, right away, outside the queue and the metrics. Variables come from the contact contactId, if you send it;…POSTPause a campaignPause a campaignPOSTResume a campaignResume a campaignPOSTCancel a campaignStops the campaign for good. Whoever has not received it yet is marked skipped, with the reason canceled.POSTDuplicate a campaignA new draft with the same setup, without the schedule.POSTArchive a campaignTakes the campaign off the main list (or brings it back, with archived: false). A campaign in progress must be cancelled or finish first.POSTResend recipients with no answerunknown recipients are sends Meta never answered. They are not retried on their own: the person may already have received it. This call puts them back in…GETCampaign metricsCounters, rates, clicks per button, grouped failures, cost per country, delivery and read latency, and the quality of the number and template before and…GETCampaign time seriesSends, deliveries, reads, clicks, failures and replies per 15-minute bucket — or 1 hour, when the campaign spans more than two days.GETList recipientsList recipientsGETExport recipients as CSVThe recipients, with the same filters as the listing and no paging, as a CSV with a UTF-8 BOM.