Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
chats
group

Update Group Settings

This endpoint updates the settings of the group

post/chats/{chat_id}/settings

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

addMembersAdminsOnlyboolean
  • When set to true, only admins can add other participants to the group
  • Default true
descriptionstring
  • Updates the group description
imagestring
  • A public image URL to update the group image
infoAdminsOnlyboolean
  • When set to true, only admins can edit group description or info
  • Default false
messagesAdminsOnlyboolean
  • When set to true, only admins can send messages to the group.
  • Default false
namestring
  • Updates the name of the group
ephemeralinteger
  • Sets the disappearing message duration in WhatsApp group
  • 0: Off (no disappearing messages)
  • 1: 24 hours
  • 7: 7 days
  • 90: 90 days
joinApprovalAdminsOnlyboolean
  • When set to true, new members must be approved by an admin before joining the group
  • Default false

Example request

{
  "addMembersAdminsOnly": true,
  "name": "Test Group Name Change",
  "ephemeral": 7,
  "joinApprovalAdminsOnly": true
}

Response

200 OK

object required

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