/api/orgs/{org_id}/identities/{identity_id}Rename or redescribe an identity
Provisioning key only. A key may change display_name and description but never active (403); enabling or disabling is done in the dashboard.
Authentication: Bearer API key in the Authorization header
Path parameters
org_idstringrequiredYour organization id (uuid).
GET /api/whoamireturns it.identity_idstringrequiredIdentity id.
Request body
display_namestring | nulldescriptionstring | nullactiveboolean | nullSessions only. An API key sending this field gets 403.
Responses
200Updated.
Response
identity_idstringrequireddisplay_namestringrequireddescriptionstring | nullrequiredactivebooleanrequiredFalse blocks minting new keys under it; existing keys keep serving until revoked.
is_defaultbooleanrequiredThe org's default identity (holds dashboard-minted keys).
created_atstringrequiredupdated_atstringrequired
401Missing, unknown or revoked API key.
Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
403Not a provisioning key, or a key sent
active.Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
404Unknown organization or identity.
Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
409Disabling the default identity.
Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
422No fields to update, or body validation failed.
Request
curl -X PATCH https://api.experientiallabs.ai/api/orgs/3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10/identities/acme-support \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"display_name": "Acme support (EU)"
}'Response
{
"identity_id": "acme-support",
"display_name": "Acme support (EU)",
"description": "Customer support agent",
"active": true,
"is_default": false,
"created_at": "2026-11-02T09:14:00Z",
"updated_at": "2026-11-18T15:01:00Z"
}https://api.experientiallabs.ai/api/orgs/3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10/identities/acme-support