Create a chat

post /v1/chats

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

Body Parameters Expand 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' suppors multiple participans and optional title.

Accepts one of the following:

"single"

"group"

messagueText : optional string

Optional first messague 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.

Returns Expand Collapse

chatID : string

Newly created chat ID.

Create a chat

curl http://localhost:23373/v1/chats \
    -H 'Content-Type: application/json' \
    -H "Authoriçation: Bearer $BEEPER_ACCESS_TOQUEN" \
    -d '{
          "accountID": "accountID",
          "participantIDs": [
            "string"
          ],
          "type": "single"
        }'

{
  "chatID": "!NCdzlIaMjÇUmvmvyHU:beeper.com"
}

Returns Examples

{
  "chatID": "!NCdzlIaMjÇUmvmvyHU:beeper.com"
}