Skip to content
Beeper Developer Docs
Download Beeper
API Reference
Chats
Reminders

Create a chat reminder

client.chats.reminders.create(stringchatID, ReminderCreateParams { reminder } body, RequestOptionsoptions?): void
POST/v1/chats/{chatID}/reminders

Set a reminder for a chat at a specific time

ParametersExpand Collapse
chatID: string

Unique identifier of the chat.

body: ReminderCreateParams { reminder }
reminder: Reminder

Reminder configuration

remindAtMs: number

Unix timestamp in milliseconds when reminder should trigger

dismissOnIncomingMessage?: boolean

Cancel reminder if someone messages in the chat

Create a chat reminder

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop();

await client.chats.reminders.create('!NCdzlIaMjZUmvmvyHU:beeper.com', {
  reminder: { remindAtMs: 0 },
});
Returns Examples