Update group member

PATCH 
/api/v2/instance/:instanceId/group/:groupJid/participant-update

The route is designed to allow modification of members of a specific group associated with a business in the CodeChat API. This route provides a flexible way to manage a group's members, allowing members to be added, removed, promoted, and demoted as needed.

Request

Path Parameters

instanceId stringrequired

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

groupJid stringrequired

Group ID

application/json

Body

required

Actions:

• add: add participants to the group.
• remove: remove participants from the group.
• promote: promote group members.
• demote: demote group members.

Participants: a list of numeric strings.

{"participants": ["5531900000000", "5531911111111"]}

action Actionrequired
participants string[]required

Responses

200

Update response.

application/json

Schema

Schema

• Array [
status string
jid string
• ]

Example (from schema)

[
  {
    "status": "string",
    "jid": "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...