AimableDocs
DocsAPI ReferenceRelease Notes
PATCH/v1/platform/principals/{principal_id}

Update Platform Principal

Path Parameters

NameTypeRequiredDescription
principal_idstring (uuid)Required

Headers

NameTypeRequiredDescription
X-API-KeystringOptional

Request Body

application/jsonRequired
is_platform_adminbooleanRequired
Authentication
X-API-Key: ak.<key_id>.<secret>Authentication & errors →

Request

curl -X PATCH '/api/v1/platform/principals/{principal_id}' \
  -H 'X-API-Key: ak.<key_id>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{
  "is_platform_admin": true
}'

Response

200

No response body documented

Error Responses