API reference

Campaigns (bulk)

Send one message to many people safely: the Number Shield paces it, respects quiet hours, skips opted-out and invalid numbers and pauses on bad signals. Content and recipients are deleted automatically after the campaign ends (keep window up to 24 h); only totals remain.

Endpoints

• POST/v2/campaignsCreate and start a campaignScope: campaigns:write
• GET/v2/campaignsList campaignsScope: campaigns:read
• GET/v2/campaigns/{campaignId}Progress, pause reason and ETAScope: campaigns:read
• GET/v2/campaigns/{campaignId}/recipientsRecipients and button repliesScope: campaigns:read
• POST/v2/campaigns/{campaignId}/startStart a draftScope: campaigns:write
• POST/v2/campaigns/{campaignId}/pausePauseScope: campaigns:write
• POST/v2/campaigns/{campaignId}/resumeResumeScope: campaigns:write
• POST/v2/campaigns/{campaignId}/cancelCancelScope: campaigns:write
• DELETE/v2/campaigns/{campaignId}Delete a draft / finished campaignScope: campaigns:write