Teams

Change a team member's role

POST/api/teams/{teamId}/users/{userId}

Updates a user's role in the specified team, subject to the caller's role and permissions.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
teamIdrequired	string	ID of the associated team.
userIdrequired	string	ID of the associated user.

Request body

Name	Type	Description
rolerequired	enum<string>	Permission role assigned to the user. Options: `team-member`, `team-view-only`, `team-manager`

Example request

{
  "role": "team-member"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
idrequired	string	Unique identifier of the resource.
rolerequired	string	Permission role assigned to the user.
teamIdrequired	string	ID of the associated team.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "role": "string",
  "teamId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/teams/{teamId}/users/{userId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "role": "team-member"
}'

PreviousAdd a team member NextCreate a team