Skip to main content
PUT
Update 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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
name
string
required
description
string
baseRole
enum<string>

The built-in role the custom role extends. Unspecified keeps the current base. Changing it re-pins every member of the role to the new base.

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
grantedActions
string[]

Replaces the full set of granted actions; an empty list removes every grant.

Response

200 - application/json

Success

data
data · object