Skip to main content

Confirm / schedule a campaign

PUT 
/api/partner-gateway/v1/campaigns/:id/confirm

Validates and confirms the campaign for sending. This is the final and irreversible step in the campaign lifecycle: once confirmed, messages will be dispatched to all recipients (either immediately or at the scheduledDate if one was set). Before calling this endpoint, ensure that: (1) The campaign has a valid sendingMode and the corresponding channel-specific fields are populated (smsSender/smsBody for SMS, rcsAgentId/rcsTemplateId for RCS, whatsappPhoneNumberId/whatsappTemplateId for WhatsApp). (2) At least one recipient source is configured (contactListIds or destinations). (3) The campaign cost has been calculated by calling POST /campaigns/{id}/calculateGoal. (4) Your account has sufficient credit to cover the total cost. (5) The readyToSend flag is set to true on the campaign. Returns 202 Accepted when the campaign is successfully confirmed and queued for delivery. Returns 400 if any validation fails: missing required fields, insufficient credit balance, readyToSend is false, or the cost has not been calculated. Returns 404 if no campaign exists with the given ID under your account. Returns 401 if the API key is missing or invalid.

Request​

Responses​

Campaign confirmed and scheduled

Last updated on