Create

API Reference

Chats

Reminders

Create a chat reminder

client.chats.reminders.create(ReminderCreateParamsbody, RequestOptionsoptions?): BaseResponse

post/v0/set-chat-reminder

Set a reminder for a chat at a specific time

ParametersExpand Collapse

body: ReminderCreateParams

chatID: string

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

reminder: Reminder

Reminder configuration

remindAtMs: number

Unix timestamp in milliseconds when reminder should trigger

dismissOnIncomingMessage?: boolean

Cancel reminder if someone messages in the chat

ReturnsExpand Collapse

BaseResponse

HTTPTypeScript

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

const client = new BeeperDesktop({
  accessToken: 'My Access Token',
});

const baseResponse = await client.chats.reminders.create({
  chatID: '!NCdzlIaMjZUmvmvyHU:beeper.com',
  reminder: { remindAtMs: 0 },
});

console.log(baseResponse.success);

200 example

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

Returns Examples

200 example

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