Delete

API Reference

Chats

Reminders

Delete a chat reminder

client.chats.reminders.delete(ReminderDeleteParamsbody, RequestOptionsoptions?): BaseResponse

post/v0/clear-chat-reminder

Clear an existing reminder from a chat

ParametersExpand Collapse

body: ReminderDeleteParams

chatID: string

The identifier of the chat to clear reminder from (accepts both chatID and local chat ID)

ReturnsExpand Collapse

BaseResponse

HTTPTypeScript

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

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

const baseResponse = await client.chats.reminders.delete({ chatID: '!NCdzlIaMjZUmvmvyHU:beeper.com' });

console.log(baseResponse.success);

200 example

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

Returns Examples

200 example

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