Custom Role API
Create Custom Role
Create a custom role on a workspace. A custom role extends a built-in base role with additional grantable actions. Assign it to a group with the Workspace Group API’s custom_role_id. Requires custom roles to be enabled for the organization.
POST
Create Custom Role
Authentication and permissions
Token requirements: User-based token (OAuth) or Organization-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.
- Default request: With a user OAuth token, you also need Edit Workspace Settings on the role’s workspace, and you can grant or revoke only actions you already hold there, unless you are an org admin of its organization.
Authorizations
Path Parameters
Body
application/json
The built-in role the custom role extends. A member holding the custom role has everything the base role grants plus granted_actions.
Available options:
TEAM_USER_ROLE_UNSPECIFIED, TEAM_USER_ROLE_AGENT, TEAM_USER_ROLE_MANAGER, TEAM_USER_ROLE_BUILDER, TEAM_USER_ROLE_VIEWER, TEAM_USER_ROLE_CONTRIBUTOR, TEAM_USER_ROLE_DRAFTER, TEAM_USER_ROLE_READONLY_AGENT, TEAM_USER_ROLE_APP_BUILDER, TEAM_USER_ROLE_APP_VIEWER, TEAM_USER_ROLE_PERSONAL_TEAM_OWNER 
