Organization Permissions

Update an organization permission

Changed on

Updates the properties of an existing organization permission. System permissions cannot be updated.

patch/organization_permissions/{permission_id}

Request

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

Path parameters

permission_idstring required

The ID of the permission to update

Request body

namestring

The name of the permission.

keystring

The key of the permission. Must have the format "org:feature:action" where feature and action are segments consisting of lowercase letters, digits, or underscores. Cannot begin with "org:sys_" as that prefix is reserved for system permissions.

descriptionstring

A description of the permission.

Response

Success

object'permission' required
idstring required
namestring required
keystring required
descriptionstring required
typestring required
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes