VoiceGateway

Change a member's organisation role

PATCH
/api/v1/org/{orgId}/members/{userId}

Authorization

consoleSession
cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
userId*string

A member's user id; one outside the named organisation is not_found.

Length1 <= length

Request Body

application/json
  1. body
role*string

The new organisation role.

Value in"Admin""Member""Viewer"

Response Body

The member with their new role.

application/json
  1. response
userId*string

The member's user id.

email*string

The member's sign-in email, case-folded.

Formatemail
role*string

Organisation role.

Value in"Admin""Member""Viewer"
Example Request
curl -X PATCH 'https://example.com/api/v1/org/string/members/string' \  -H 'Content-Type: application/json' \  -d '{  "role": "Admin"}'
Example Response
{  "userId": "string",  "email": "user@example.com",  "role": "Admin"}

Was this page helpful?