Delete a scheduled message
DELETE https://connect.xfel.eu/api/v1/scheduled_messages/{scheduled_message_id}
Delete, and therefore cancel sending, a previously scheduled
message.
Changes: New in Zulip 7.0 (feature level 173).
Usage examples
curl -sSX DELETE https://connect.xfel.eu/api/v1/scheduled_messages/1 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
scheduled_message_id integer required in path
Example: 1
The ID of the scheduled message to delete.
This is different from the unique ID that a message would have
after it was sent.
Response
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success"
}
Example response for when no scheduled message exists with the provided ID.
{
"code": "BAD_REQUEST",
"msg": "Scheduled message does not exist",
"result": "error"
}