Skip to main content

Update a campaign

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

Updates the details of an existing campaign. Only campaigns that are still DRAFT or READY_TO_SEND, and have not started sending, can be modified. Once confirmed with PUT /campaigns/{id}/confirm (status PRE_BILLED and later), a campaign can no longer be updated. You can use this endpoint to change the campaign name, description, message body, sender, recipient contact lists, sending mode, scheduled date, or the readyToSend flag. Omitted fields keep their current value, with two exceptions: an update without scheduledDate removes the campaign's schedule, and an update without readyToSend=true moves the campaign back to DRAFT. Repeat both in every update of a scheduled campaign that is ready to send. A common workflow is to create a campaign as a draft (readyToSend=false), iterate on its configuration using this endpoint, then set readyToSend=true when the campaign is finalized, and finally call PUT /campaigns/{id}/confirm to dispatch it. After updating recipient lists or message content, call GET /campaigns/{id}/price to see the new recipient count and price. Returns 400 if the request body is invalid or if the campaign is in a non-editable state. 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 updated successfully

Last updated on