Create

API Reference

Chats

Reminders

Create a chat reminder

chats.reminders.create(strchat_id, ReminderCreateParams**kwargs) -> BaseResponse

post/v1/chats/{chatID}/reminders

Set a reminder for a chat at a specific time

ParametersExpand Collapse

chat_id: str

Unique identifier of the chat.

reminder: Reminder

Reminder configuration

remind_at_ms: float

Unix timestamp in milliseconds when reminder should trigger

dismiss_on_incoming_message: Optional[bool]

Cancel reminder if someone messages in the chat

ReturnsExpand Collapse

class BaseResponse: …

success: bool

error: Optional[str]

Create a chat reminder

python

• http
• typescript
• python
• go

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token="My Access Token",
)
base_response = client.chats.reminders.create(
    chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com",
    reminder={
        "remind_at_ms": 0
    },
)
print(base_response.success)

200 example

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

Returns Examples

200 example

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