Organization Roles

Update an organization role

Changed on

Updates an existing organization role. You can update the name, key, description, and permissions of the role. All parameters are optional - you can update only the fields you want to change. If the role is used as a creator role or domain default role, updating the key will cascade the update to the organization settings.

patch/organization_roles/{organization_role_id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/organization_roles/{organization_role_id}
  • Auth: HTTP bearer

Path parameters

organization_role_idstring required

The ID of the organization role to update

Request body

namestring nullable

The new name for the organization role

keystring nullable

A unique key for the organization role. Must start with 'org:' and contain only lowercase alphanumeric characters and underscores.

descriptionstring nullable

Optional description for the role

permissionsstring[] nullable

Array of permission IDs to assign to the role. If provided, this will replace the existing permissions.

Response

Success

object'role' required
idstring required
namestring required
keystring required
descriptionstring nullable required
is_creator_eligibleboolean required

Whether this role is eligible to be an organization creator role

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes