Cancel a scheduled message
POST/chat.scheduled.cancel
Cancels a pending message scheduled via /chat.post's
sendAt, so it will never be delivered. Pending scheduled messages can be
discovered with /chat.scheduled.list.
Only the credential's bot identity that scheduled the message may cancel it. A
scheduledMessageId scheduled by a different identity — or one that never
existed — returns scheduled_message_not_found; the endpoint does not reveal
whether such an id exists. Canceling a message that has already been sent
returns scheduled_message_already_sent.
Cancellation is best-effort once the scheduled send time arrives: delivery of a
due message begins in the seconds after its sendAt boundary, and a cancel
issued inside that window may return success while the message is still
delivered. Cancel ahead of the scheduled time to be safe.
Access: Organization and Personal.
Required scope: chat:send_message or chat:write
OpenAPI Spec: chat-v1.json
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 409
- 500
Scheduled message canceled; it will not be delivered.
Bad request. Common causes:
- Missing
scheduledMessageId(missing_parameter) - Malformed JSON body (
invalid_json)
Presented invalid authentication credentials.
Token lacks a required scope (missing_scope).
The scheduled message could not be found, or was scheduled by a different credential (scheduled_message_not_found).
An unsupported method was requested.
The message was already sent (or its delivery has begun) and can no longer be canceled (scheduled_message_already_sent).
An internal error occured.