Create

API Reference

Chats

Reminders

Create a chat reminder

post/v0/set-chat-reminder

Set a reminder for a chat at a specific time

Body ParametersExpand Collapse

chatID: string

The identifier of the chat to set reminder for (accepts both chatID and local chat ID)

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

ReturnsExpand Collapse

BaseResponse

HTTPTypeScript

curl http://localhost:23373/v0/set-chat-reminder \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com",
          "reminder": {
            "remindAtMs": 0
          }
        }'

200 example

{
  "success": true,
  "error": "error"
}

Returns Examples

200 example

{
  "success": true,
  "error": "error"
}