Cancel a scheduled message

DELETE 
/v1/desks/:desk_id/conversations/:session_id/scheduled-messages/:scheduled_message_id

Cancel a pending scheduled message. This operation is idempotent - cancelling an already-cancelled, already-delivered, or unknown scheduled message returns the same 204 No Content response.

Permissions - desks.read and conversations.write. API keys - not supported; requires user (JWT) authentication.

Request

Responses

204

The scheduled message was cancelled (or did not exist)

400

BadRequest

Response Headers

X-Request-Id
Unique identifier for the API request, useful for debugging and tracking.
Example: abc123xyz789

401

Unauthorized

Response Headers

X-Request-Id
Unique identifier for the API request, useful for debugging and tracking.
Example: abc123xyz789

403

Forbidden - scheduled messages require user authentication, not API keys

404

The specified resource was not found

Response Headers

X-Request-Id
Unique identifier for the API request, useful for debugging and tracking.
Example: abc123xyz789

500

Internal Server Error

Response Headers

X-Request-Id
Unique identifier for the API request, useful for debugging and tracking.
Example: abc123xyz789