Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
chats
group

Create Group

This endpoint creates a new group.

  • Note that creating a new 1-1 chat does not require any explicit API. Sending a message will automatically create the chat
post/chats/create

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

group_namestring required
  • Provide the name of the group to be created
participantsstring[] required
  • Provide a list of participants to be added to the group (in country_code + number format).
  • Participants will be directly added to the group if they are in your phone contacts and their privacy settings allow it. If not, participants will receive an invite to join the group

Example request

{
  "group_name": "Test New 1040"
}

Response

200 OK

object required

The response is a chat object for the new created group. Refer to the chat object here