Skip to main content
PATCH
/
permissions
/
{id}
curl -X PATCH 'https://api.example.com/permissions/perm_123' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Can read and preview documents"
  }'

{
  "id": "perm_123",
  "name": "read:documents",
  "description": "Can read and preview documents",
  "scopeId": "scope_456"
}

​
Path Parameters

​
id
string
required
The unique identifier of the permission to update

​
Request Body

​
name
string
Updated display name for the permission
​
description
string
Updated description of the permission

​
Response

Returns the updated permission object. 
curl -X PATCH 'https://api.example.com/permissions/perm_123' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Can read and preview documents"
  }'

{
  "id": "perm_123",
  "name": "read:documents",
  "description": "Can read and preview documents",
  "scopeId": "scope_456"
}