API ReferenceTeams

Manage team member roles

View as Markdown

Adds or removes member roles in groups, teams, organizations, as well as individual users’ roles.

Note:

If you remove a role from a group or team, then all members lose the that role’s permissions.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

teamIdintegerRequired
The team's ID.

Headers

identifierTypestringOptional
Use SCIM user and group IDs instead of Postman user IDs.

Request

This endpoint expects an object.
addobjectOptional
The role assignments to add.
removeobjectOptional
The role assignments to remove.

Response

Successful Response
resultlist of objectsOptional
A list of the role changes that were applied.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error