Role Sets

Update a role set

Changed on

Updates an existing role set. You can update the name, key, description, type, default role, or creator role. All parameters are optional - you can update only the fields you want to change.

patch/role_sets/{role_set_key_or_id}

Request

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

Path parameters

role_set_key_or_idstring required

The key or ID of the role set to update

Request body

namestring nullable

The new name for the role set

keystring nullable

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

descriptionstring nullable

Optional description for the role set

type'initial' nullable

Set to "initial" to make this the default role set for new organizations. Only one role set can be "initial" per instance; setting this will change any existing initial role set to "custom".

default_role_keystring nullable

The key of the role to use as the default role for new organization members. Must be an existing role in the role set.

creator_role_keystring nullable

The key of the role to assign to organization creators. Must be an existing role in the role set.

Response

Success

object'role_set' required
idstring required

The unique identifier of the role set

namestring required

The name of the role set

keystring required

A unique key for the role set (e.g., "role_set:default")

descriptionstring nullable required

Optional description of the role set

type'initial' | 'custom' required

The type of the role set ("initial" or "custom")

created_atinteger required

Unix timestamp of role set creation

updated_atinteger required

Unix timestamp of last role set update

Changes