Reference / Roles

Update a custom role.

PATCH /v1/roles/{id}

Secret API key operationId: update

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

id string<uuid> required

Role id

Request body · required

description string
name string
permissions string[]

Responses

200 Role updated

{
  "data": {
    "created_at": "2026-01-15T09:30:00Z",
    "description": "string",
    "effective": [
      "string"
    ],
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "is_system": false,
    "key": "string",
    "name": "string",
    "permissions": [
      "string"
    ]
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

403 System roles are immutable

404 No such role

Request

curl -X PATCH "http://localhost:8080/v1/roles/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "name": "string",
  "permissions": [
    "string"
  ]
}'

Try it

live request

PATCH http://localhost:8080/v1/roles/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f

Path parameters

id *

Request body

application/json