ComRaidComRaid Docs
API referenceCampaigns

Cancel every cancellable Message under a Campaign

Cancels each child Message that is `scheduled`, `preparing`, or `processing` using the same rule as `cancelMessage`: Deliveries not yet offered to the Provider become `skipped` with reason `cancelled`; Deliveries already sent stay sent. Finished child Messages (`completed`, `failed`, or already `cancelled`) are left unchanged. Returns 409 when the Campaign has no cancellable Messages.

POST
/campaigns/{id}/cancel

Cancels each child Message that is scheduled, preparing, or processing using the same rule as cancelMessage: Deliveries not yet offered to the Provider become skipped with reason cancelled; Deliveries already sent stay sent. Finished child Messages (completed, failed, or already cancelled) are left unchanged. Returns 409 when the Campaign has no cancellable Messages.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Path Parameters

id*string
Formatuuid

Response Body

At least one child Message was cancelled

application/json
  1. response
campaign_id*string
Formatuuid
cancelled_count*integer

Number of child Messages cancelled by this request

Example Request
curl -X POST 'https://api.comraid.io/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'
Example Response
{  "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",  "cancelled_count": 0}