Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:49 UTC

Cancel

POST /campaigns/:campaign/cancel

A Campaign is a message sent to multiple recipients. They can be cancelled when their state is either “scheduled” or “sending”. This will retain the Campaign and will update its status to be “cancelled”, as well as prevent any unprocessed recipients from being attempted and will return the unused quota back to the user.

Examples

Cancel a Campaign

Request

POST /campaigns/1zO27OO/cancel
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /campaigns/1zO27OO/cancel
    

Response

Status

200

Response Type

No body


© 2021 TextUs