Skip to main content
DELETE
/
v1
/
messages
/
cancel
Cancel scheduled messages
curl --request DELETE \
  --url https://pilotstatus.com.br/v1/messages/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "messageIds": [
    "msg_01HZX...",
    "msg_02HZX..."
  ]
}
'
{
  "cancelled": 2,
  "notFound": 0
}

Authorizations

x-api-key
string
header
required

Your ps_ API key

Body

application/json
messageIds
string
required

Ids of scheduled messages to cancel.

Example:

"[\"msg_01HZX...\", \"msg_02HZX...\"]"

Response

Cancel scheduled