Skip to content
  • Auto
  • Light
  • Dark
Download Beeper

Create a chat reminder

Deprecated
POST
/v0/set-chat-reminder

Set a reminder for a chat at a specific time. Use POST /v1/chats/{chatID}/reminders instead.

object
chatID
required

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

string
Example
!NCdzlIaMjZUmvmvyHU:beeper.com
reminder
required

Reminder configuration

object
remindAtMs
required

Unix timestamp in milliseconds when reminder should trigger

number
dismissOnIncomingMessage

Cancel reminder if someone messages in the chat

boolean

Tool executed successfully

object
success
required
boolean
error
string

Invalid request parameters

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Access token is missing or invalid

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Access token does not have the required scope

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Resource not found

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Unprocessable entity - validation error

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Too many requests - rate limit exceeded

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Internal server error

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string