Update Chat
Update metadata and sensitive data storage settings for an existing chat.
Authorizations
Path Parameters
Body
Data storage setting for this chat. Overrides the agent's default setting. "everything" stores all data, "basic_attributes_only" stores only metadata. Cannot be downgraded from more restrictive to less restrictive settings.
everything, basic_attributes_only "everything"
Override dynamic variables represented as key-value pairs of strings. Setting this will override or add the dynamic variables set in the agent during the call. Only need to set the delta where you want to override, no need to set the entire dynamic variables object. Setting this to null will remove any existing override.
Custom attributes for the chat, as key-value pairs. Each attribute must first be defined for your organization in the Retell dashboard (Chat History → Actions → Custom attributes) before it can be set here. The object key must match the id of an existing organization-level custom attribute; keys that do not match a defined attribute are ignored and will not be saved. Values must be a string, number, or boolean.
Response
Chat metadata updated successfully
Status of chat.
ongoing: Chat session is ongoing, chat agent can receive new message and generate response.ended: Chat session has ended, and no longer can generate new response.error: Chat encountered error.
ongoing, ended, error "ongoing"
Transcription of the chat, including human replies labeled "Transfer Target".
"Agent: hi how are you doing?\nUser: Doing pretty well. How are you?\nAgent: That's great to hear! I'm doing well too, thanks! What's up?\nUser: I don't have anything in particular.\nAgent: Got it, just checking in!\nUser: Alright. See you.\nAgent: have a nice day\n"
Tool call invocations and results of integration tools run before the chat's first message (pre-session). Stored separately from the main transcript. Available once pre-session integration tools have run (from the chat's first turn).
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Tool call invocations and results of integration tools run after post-chat analysis (post-session). Stored separately from the main transcript. Available after chat ends if post-session integration tools ran.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7

