Create a message reminder

POST https://chat.zulip.org/api/v1/reminders

Schedule a reminder to be sent to the current user at the specified time. The reminder will link the relevant message.

Changes: New in Zulip 11.0 (feature level ZF-f8d751).

Usage examples

curl -sSX POST https://chat.zulip.org/api/v1/reminders \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode message_id=1 \
    --data-urlencode scheduled_delivery_timestamp=5681662420

Parameters

Response

Return values

• reminder_id: integer

  Unique ID of the scheduled message reminder.

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": "",
    "reminder_id": 42,
    "result": "success"
}