Cancel a scheduled message
Cancel a scheduled message that hasn't started yet. The row is deleted.
DELETE
https://api.centerfy.ai/webhooks/inbound/scheduled-messages/:id Headers
| Header | Required | Value | Description |
|---|---|---|---|
x-api-key | Yes | your sub-account API key (cfy_…) | Authenticates the request; or use Authorization: Bearer <key>. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | The scheduled message id. |
Example
curl -X DELETE "https://api.centerfy.ai/webhooks/inbound/scheduled-messages/{id}" \
-H "x-api-key: $CENTERFY_API_KEY" import { CenterfyClient } from "@centerfy/sdk";
const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });
const result = await centerfy.scheduledMessages.cancel("<scheduledMessageId>");
console.log(result); centerfy scheduledMessages cancel <scheduledMessageId> MCP tool: centerfy_scheduled_messages_cancel (see MCP server)
Response
{
"status": "success",
"cancelled": true,
"scheduled_message_id": "9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c2d"
}Errors
404— if the scheduled message is not in this sub-account.
Notes
Only pending messages can be cancelled: 409 (with scheduled_message_status) once the message is processing, completed or failed, or if it started while you were cancelling.