Chats

Create a chat

Create a single or group chat on a specific account using participant IDs and optional title.

post/v1/chats

Request body

accountIDstring required

Account to create the chat on.

type'single' | 'group' required

Chat type to create: 'single' requires exactly one participantID; 'group' supports multiple participants and optional title.

participantIDsstring[] required

User IDs to include in the new chat.

titlestring

Optional title for group chats; ignored for single chats on most platforms.

messageTextstring

Optional first message content if the platform requires it to create the chat.

Request executed successfully

chatIDstring required

Newly created chat ID.

{
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com"
}