Create

API Reference

Chats

Reminders

Create a chat reminder

post/v1/chats/{chatID}/reminders

Set a reminder for a chat at a specific time

Path ParametersExpand Collapse

chatID: string

Unique identifier of the chat.

Body ParametersExpand Collapse

reminder: object { remindAtMs, dismissOnIncomingMessage }

Reminder configuration

remindAtMs: number

Unix timestamp in milliseconds when reminder should trigger

dismissOnIncomingMessage: optional boolean

Cancel reminder if someone messages in the chat

Create a chat reminder

http

• http
• typescript
• python
• go

curl http://localhost:23373/v1/chats/$CHAT_ID/reminders \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "reminder": {
            "remindAtMs": 0
          }
        }'

Returns Examples