Groups

Update member role

Updates a member's role in a group.

patch/v1/groups/{group_id}/members/{participant_id}

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/groups/{group_id}/members/{participant_id}
  • Auth: HTTP bearer

Path parameters

group_idstring uuid required

The group's id.

participant_idstring required

The participant's id, or ext: followed by the participant's external_id.

Request body

on_behalf_of_participant_idstring uuid

The participant who asked for this change. Scrip stores it with the membership record; the API does not return it.

role'MEMBER' | 'ADMIN' required

New role for the member: MEMBER or ADMIN

Example request

{
  "on_behalf_of_participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b007",
  "role": "ADMIN"
}

Response

Member role updated

messagestring

Confirmation message

participant_idstring uuid

Participant whose role was updated

rolestring

New role after update

Example response

{
  "message": "Member role updated",
  "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
  "role": "ADMIN"
}

Changes

No recorded changes to this operation across all 1 revision of this API.