Agentcallers

Update Caller

Update the customer-editable fields on a caller. PATCH semantics: omitted fields are unchanged, present fields overwrite. To clear a nullable field (display_name, external_ref) pass an empty string. metadata REPLACES the existing JSONB blob when supplied.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Request

This endpoint expects an object.
display_namestring or nullOptional

Operator-editable display name. Empty string clears the column.

external_refstring or nullOptional
Optional handle into the customer's own CRM. Empty string clears the column.
metadatamap from strings to anyOptional

Replacement metadata JSONB. Must not be null.

Response

The refreshed caller row.
callerobject

First-class Caller entity. Identified by the (tenant, agent, identity) triple. Memories and conversations FK at it via caller_id.

Errors

400
Bad Request Error
404
Not Found Error