Update Clerk organization role

Update an organization role in a connected Clerk application.

← All Clerk endpoints · Capability overview

PATCH/v1/clerk/organization-roles/{role_id}

https://api.vee3.io/v1/clerk/organization-roles/{role_id}

8 tokens

Update an organization role 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.update_organization_role

Parameters6 fields

clerk_instance_idstringOptional

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

role_idstringRequired

Clerk organization role id to retrieve, update, delete, or assign permissions to.

namestringOptional

Updated role display name.

descriptionstringOptional

Updated role description.

is_creator_eligiblebooleanOptional

Whether this role may be assigned as organization creator.

permissionsarrayOptional

Permission keys to assign to the role.

Response16 fields

organization_roleobject

15 fields

Updated organization role summary.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

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

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/organization-roles/{role_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "role_id": "orgrole_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200An updated organization role.

updated_organization_role.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "name": "Admin",
    "key": "org:admin",
    "description": "Organization administrator",
    "is_creator_eligible": true,
    "permissions": [
      {
        "id": "orgperm_2abc123",
        "name": "Manage billing",
        "key": "org:sys_billing:manage",
        "description": "Manage organization billing",
        "type": "system",
        "created_at": 1710000000000,
        "updated_at": 1710000000000
      }
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}