Create

API Reference

Chats

Reminders

Create a chat reminder

client.Chats.Reminders.New(ctx, chatID, body) (*BaseResponse, error)

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 ChatReminderNewParams

Reminder param.Field[ChatReminderNewParamsReminder]

Reminder configuration

RemindAtMs float64

Unix timestamp in milliseconds when reminder should trigger

DismissOnIncomingMessage booloptional

Cancel reminder if someone messages in the chat

ReturnsExpand Collapse

type BaseResponse struct{…}

Success bool

Error stringoptional

Create a chat reminder

go

• http
• typescript
• python
• go

package main

import (
  "context"
  "fmt"

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

func main() {
  client := beeperdesktopapi.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  baseResponse, err := client.Chats.Reminders.New(
    context.TODO(),
    "!NCdzlIaMjZUmvmvyHU:beeper.com",
    beeperdesktopapi.ChatReminderNewParams{
      Reminder: beeperdesktopapi.ChatReminderNewParamsReminder{
        RemindAtMs: 0,
      },
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", baseResponse.Success)
}

200 example

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

Returns Examples

200 example

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