1. Docs
  2. API Reference
  3. Update permission metadata

Update permission metadata

PATCH/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/permissions/{id}

Updates a permission's name, description, and/or category by id (description accepts null to clear; name and category can be changed but never cleared); the permission key and source are immutable. Supports optimistic concurrency via the If-Match header carrying the permission's current version — a stale version returns 409. Requires the rbac.manage_roles permission.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability env_permissions.manageDeveloper Console

Create, edit, and delete permissions. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

idstring Required

Headers

  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since.

Request body

application/json

namestring Optional

Updated name

descriptionstring Optional

Updated description

categorystring Optional

Updated category

Responses

application/json

  • dataPermissionResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

PermissionResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/permissions/value" \
  -H "If-Match: "3"" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "category": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "key": "string",
    "name": "string",
    "description": "string",
    "category": "string",
    "source": "system",
    "created_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}
 Related endpoints
GETList permission catalog
POSTRegister new permission(s)
POSTExplain a node-scoped authorization decision
GETGet a permission
DELETERemove a permission
GETGet where a permission is used
 Was this page helpful?

Tell us how we can improve this guide.

Canopy