Skip to content
  • Auto
  • Light
  • Dark
Download Beeper

Create a chat

Deprecated
POST
/v0/create-chat

Create a single or group chat on a specific account using participant IDs and optional title. Use POST /v1/chats instead.

object
accountID
required

Account to create the chat on.

string
type
required

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

string
Allowed values: single group
participantIDs
required

User IDs to include in the new chat.

Array<string>
>= 1 items
title

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

string
messageText

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

string

Tool executed successfully

object
success
required
boolean
error
string
chatID

Newly created chat if available.

string
Example
!NCdzlIaMjZUmvmvyHU:beeper.com

Invalid request parameters

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Access token is missing or invalid

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Access token does not have the required scope

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Resource not found

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Unprocessable entity - validation error

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Too many requests - rate limit exceeded

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Internal server error

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string