Create a message reminder
POST https://runix.chat/api/v1/reminders
Schedule a reminder to be sent to the current user at the specified time,
or when an agent run ends. The reminder will link the relevant message.
Changes: In Zulip 13.0 (feature level ZF-a20530), added the
agent_run_id parameter.
New in Zulip 11.0 (feature level 381).
Usage examples
The -u line implements HTTP Basic authentication.
See the Authorization header documentation for how
to get those credentials for Zulip users and bots.
curl -sSX POST https://runix.chat/api/v1/reminders \
-u EMAIL_ADDRESS:API_KEY \
--data-urlencode message_id=1 \
--data-urlencode scheduled_delivery_timestamp=5681662420 \
--data-urlencode agent_run_id=12 \
--data-urlencode 'note=This is a reminder note.'
Parameters
message_id integer optional
Example: 1
The ID of the previously sent message to reference in the reminder message.
scheduled_delivery_timestamp integer optional
Example: 5681662420
The UNIX timestamp for when the reminder will be sent,
in UTC seconds.
Required, unless agent_run_id is given instead.
Changes: Before Zulip 13.0 (feature level ZF-a20530),
this parameter was always required.
agent_run_id integer optional
Example: 12
The ID of an agent run that has not ended yet. When given
instead of scheduled_delivery_timestamp, the reminder is
sent when the run first ends: done, failed or cancelled.
The run must be one the current user can see.
Changes: New in Zulip 13.0 (feature level ZF-a20530).
note string optional
Example: "This is a reminder note."
A note associated with the reminder shown in the Notification Bot message.
Changes: New in Zulip 11.0 (feature level 415).
Response
Return values
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"
}