Skip to content
Download Beeper

Create a chat reminder

client.Chats.Reminders.New(ctx, chatID, body) error
POST/v1/chats/{chatID}/reminders

Set a reminder for a chat at a specific time.

ParametersExpand Collapse
chatID string

Chat ID. Input routes also accept the local chat ID from this installation when available.

body ChatReminderNewParams
Reminder param.Field[ChatReminderNewParamsReminder]

Reminder configuration

RemindAt Time

Timestamp when the reminder should trigger.

formatdate-time
DismissOnIncomingMessage boolOptional

Cancel reminder if someone messages in the chat

Create a chat reminder

package main

import (
  "context"
  "time"

  "github.com/beeper/desktop-api-go"
  "github.com/beeper/desktop-api-go/option"
)

func main() {
  client := beeperdesktopapi.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  err := client.Chats.Reminders.New(
    context.TODO(),
    "!NCdzlIaMjZUmvmvyHU:beeper.com",
    beeperdesktopapi.ChatReminderNewParams{
      Reminder: beeperdesktopapi.ChatReminderNewParamsReminder{
        RemindAt: time.Now(),
      },
    },
  )
  if err != nil {
    panic(err.Error())
  }
}
Returns Examples