ComRaidComRaid Docs
API referenceMessages

Cancel a Message while scheduled, preparing, or processing

Cancels a Message while it is `scheduled`, `preparing`, or `processing`. Deliveries not yet offered to the Provider become `skipped` with reason `cancelled`; Deliveries already sent stay sent. A finished Message (`completed`, `failed`, or already `cancelled`) returns 409.

POST
/messages/{id}/cancel

Cancels a Message while it is scheduled, preparing, or processing. Deliveries not yet offered to the Provider become skipped with reason cancelled; Deliveries already sent stay sent. A finished Message (completed, failed, or already cancelled) returns 409.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Path Parameters

id*string
Formatuuid

Response Body

Cancelled

application/json
  1. response
message_id?string
Formatuuid
status?"cancelled"
Value in"cancelled"
Example Request
curl -X POST 'https://api.comraid.io/messages/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'
Example Response
{  "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",  "status": "cancelled"}