Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-phone
string

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

Body

application/json
group_name
string
required
  • Provide the name of the group to be created
participants
string[]
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
options
object
  • Provide additional options while creating a group

Response

200 - application/json

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