Skip to main content
PATCH
Update member role
Updates a member’s role within a group. Valid roles are MEMBER and ADMIN. Promoting a member to ADMIN and demoting an admin to MEMBER both go through this endpoint. A group must always have at least one ADMIN; attempting to demote the last admin returns an error. To remove the final admin from a group, promote another member first, then remove the original. You can include on_behalf_of_participant_id in the body to record which participant initiated the change for audit purposes.
For usage patterns and examples, see the Groups guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

participantId
string<uuid>
required

Participant ID

Body

application/json

New role

role
enum<string>
required

New role for the member: MEMBER or ADMIN

Available options:
MEMBER,
ADMIN
Example:

"ADMIN"

on_behalf_of_participant_id
string<uuid>

Participant who initiated this change, for audit purposes

Example:

"550e8400-e29b-41d4-a716-446655440001"

Response

Member role updated

message
string

Confirmation message

Example:

"Member role updated"

participant_id
string<uuid>

Participant whose role was updated

Example:

"550e8400-e29b-41d4-a716-446655440000"

role
string

New role after update

Example:

"ADMIN"