Skip to main content
PUT
/
api
/
v1
/
chats
/
{chatId}
/
members
Update group members
curl --request PUT \
  --url http://localhost:{port}/api/v1/chats/{chatId}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "participantId": "<string>",
    "action": "update",
    "role": "member"
  }
]
'
{
  "success": true,
  "chatId": "<string>",
  "message": "<string>",
  "details": [
    "<any>"
  ]
}

Authorizations

Authorization
string
header
required

JWT token authentication

Path Parameters

chatId
string
required

ID of the group chat

Body

application/json · object[]

List of operations to perform on group members

participantId
string
required

ID of the participant (e.g., "[email protected]")

action
enum<string>
default:update

Action to perform on the member

Available options:
add,
remove,
update
role
enum<string>
default:member

Role of the member

Available options:
member,
admin

Response

Group members updated successfully

success
boolean
required

Whether the action was successful

chatId
string

ID of the group the action was performed on

message
string

Additional details about the operation result

details
any[]

Detailed results of multiple operations