Vee3

Create Clerk role set

Create a new role set in a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/role-sets

https://api.vee3.io/v1/clerk/role-sets

10 tokens

Create a new role set in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.create_role_set
Parameters8 fields
clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

namestringRequired

Role set display name.

default_role_keystringRequired

Key of the default role for new members.

creator_role_keystringRequired

Key of the role assigned to organization creators.

rolesarrayRequired

Role keys to include in the role set.

keystringOptional

Unique role set key.

descriptionstringOptional

Role set description.

typestringOptional

Role set type.

Response35 fields
role_setobject
34 fields

Newly created role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems
8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject
8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject
8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required