patch

Update a team member role

Changes a member's role or internal notes. Identify the member by user account UUID in the path (not the team membership record ID).

Required API key scope

members:update

/api/v1/team/members/{userId}

Code samples

curl --request PATCH \
  --url https://api.emailguard.co/api/v1/team/members/YOUR_ID \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Parameters

Path parameters

Name	Type	Description
userIdrequired	string	User account UUID of the member to update

Request body

New role and/or notes for the member

idstringrequired

Internal team member record ID. When calling the public API, this is set from the path userId.

notesstring

Internal notes about the member. Omit to leave unchanged.

rolestring

New team role (for example Owner, Admin, Member). Omit to leave unchanged. See Team roles and permissions.