Change Group Chat Settings

PATCH 
/api/v2/instance/:instanceId/group/:groupJid/settings

This endpoint allows you to change chat settings for a specific WhatsApp group. Settings can control who can comment and who can edit group data.

Request

Path Parameters

instanceId stringrequired

The unique identifier of the group whose settings will be changed.

groupJid stringrequired

The unique identifier of the group for which you want to fetch information.

application/json

Body

required

• settings (enum, required)
• announcement: only admins can comment.
• not_announcement: everyone can comment.
• locked: only administrators can edit group data.
• unlocked: everyone can edit group data.

setting Settingrequired

Default value: announcement | locked | not_announcement | unlocked

Responses

200

Setting Updated

application/json

Schema

Schema

updated boolean
setting string

Example (from schema)

{
  "updated": true,
  "setting": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...