Sign in

v10

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-02-242335121.2 KB
Chats

Create or start a chat

Create a single/group chat (mode='create') or start a direct chat from merged user data (mode='start').

post/v1/chats

Request body

accountIDstring required

Account to create or start the chat on.

mode'create' | 'start'

Operation mode. Defaults to 'create' when omitted.

type'single' | 'group'

Required when mode='create'. 'single' requires exactly one participantID; 'group' supports multiple participants and optional title.

participantIDsstring[]

Required when mode='create'. User IDs to include in the new chat.

titlestring

Optional title for group chats when mode='create'; ignored for single chats on most platforms.

messageTextstring

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

allowInviteboolean

Whether invite-based DM creation is allowed when required by the platform. Used for mode='start'.

Response

Request executed successfully

chatIDstring required

Newly created chat ID.

status'existing' | 'created'

Only returned in start mode. 'existing' means an existing chat was reused; 'created' means a new chat was created.

Example response

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