Groundeddocs
ReferenceTeams

Change a member's role

PATCH/v1/teams/{team}/members/{userId}

409 sso_managed (details {ruleId, group}) when an SSO group mapping rule manages the membership: the role would be set back at the person's next sign-in. 409 last_owner for the team's only owner.

Path Parameters

team*string

Team slug or ID

userId*string
Formatuuid

Header Parameters

If-Match*string

The resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/teams/string/members/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "role": "owner"  }'
{  "data": {    "user": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "displayName": "string",      "status": "active"    },    "role": "owner",    "revision": 0,    "createdAt": "2019-08-24T14:15:22Z",    "managedBy": {      "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",      "group": "string"    }  }}