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

Path Parameters

chat_id
string
required

Body

application/json
name
string
required
  • Updates the name of the group
description
string
  • Updates the group description
image
string
  • A public image URL to update the group image
infoAdminsOnly
boolean
  • When set to true, only admins can edit group description or info
  • Default false
memberAddMode
boolean
  • When set to true, only admins can add other participants to the group
  • Default true
messagesAdminsOnly
boolean
  • When set to true, only admins can send messages to the group.
  • Default false

Response

200 - application/json

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