Skip to main content
PUT
Update Agent Identity

Overview

Updates the identity fields you send and leaves the rest untouched, so a partial body is fine. Send at least one known field; an empty object returns 400 BAD_REQUEST. Changing any card field rebuilds the contact card, so vcf_file_id and vcf_url change even though you did not send them. Read the identity back with Get Agent Identity if you need the new values. Requires an admin, owner, operator, or prompter role.

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The agent’s unique identifier.

Body Parameters

Every field is optional, but the body must contain at least one of them and must be an object. Unknown keys are ignored. String fields are trimmed, and sending null clears a field to an empty string.
string
The name shown to the recipient. At most 80 characters, and it cannot be set to an empty value once you send the key.
string
Short line describing the agent. At most 140 characters.
string
Contact email. At most 254 characters and must be a valid address.
string
Website. At most 2048 characters and must be a valid http or https URL.
string
Postal address. At most 300 characters.
boolean
Whether to deliver the contact card automatically.
boolean
Whether rich messaging is allowed for this agent.
boolean
Whether verified caller display is switched on.

Response

Returns the full identity in the same shape as Get Agent Identity, reflecting the update.
object
The updated identity. See Get Agent Identity for every field.
null | array
null on success, or a list of error objects if the request failed. Validation failures return 400 BAD_REQUEST with a message naming the field.

Docs for agents: llms.txt