Create

API Reference

Chats

Create a chat

post/v1/chats

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

Body ParametersExpand Collapse

accountID: string

Account to create the chat on.

participantIDs: array of string

User IDs to include in the new chat.

type: "single" or "group"

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

Accepts one of the following:

"single"

"group"

messageText: optional string

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

title: optional string

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

ReturnsExpand Collapse

chatID: optional string

Newly created chat if available.

Create a chat

http

• http
• typescript
• python
• go

curl http://localhost:23373/v1/chats \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
          "participantIDs": [
            "string"
          ],
          "type": "single"
        }'

200 example

{
  "success": true,
  "error": "error",
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com"
}

Returns Examples

200 example

{
  "success": true,
  "error": "error",
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com"
}