PATCH /update-chat/{chat_id} – Retell AI Retell SDK

Update metadata and sensitive data storage settings for an existing chat.

patch/update-chat/{chat_id}

Path parameters

chat_idstring required

Example:chat_98c1a2157aa0559144d67bb0729

The chat id of the chat to be updated.

Request body

metadataobject

An arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the chat. Not used for processing. You can later get this field from the chat object. Size limited to 50kB max.

data_storage_setting'everything' | 'basic_attributes_only'

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.

override_dynamic_variablesobject nullable

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_attributesobject

Custom attributes for the chat

Example request

{
  "data_storage_setting": "everything",
  "override_dynamic_variables": {
    "additional_discount": "15%"
  },
  "custom_attributes": {
    "custom_attribute_1": "value1",
    "custom_attribute_2": "value2"
  }
}

Response

Chat metadata updated successfully

chat_idstring required

Unique id of the chat.

agent_idstring required

Corresponding chat agent id of this chat.

versioninteger nullable

The version of the agent

retell_llm_dynamic_variablesobject

Add optional dynamic variables in key value pairs of string that injects into your Response Engine prompt and tool description. Only applicable for Response Engine.

collected_dynamic_variablesobject

Dynamic variables collected from the chat. Only available after the chat ends.

chat_status'ongoing' | 'ended' | 'error' required

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.

chat_type'api_chat' | 'sms_chat'

Type of the chat

custom_attributesobject

Custom attributes for the chat

start_timestampinteger

Begin timestamp (milliseconds since epoch) of the chat. Available after chat starts.

end_timestampinteger nullable

End timestamp (milliseconds since epoch) of the chat. Available after chat ends.

transcriptstring

Transcription of the chat.

metadataobject

Example response

{
  "chat_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
  "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
  "version": 1,
  "retell_llm_dynamic_variables": {
    "customer_name": "John Doe"
  },
  "collected_dynamic_variables": {
    "last_node_name": "Test node"
  },
  "chat_status": "ongoing",
  "chat_type": "api_chat",
  "start_timestamp": 1703302407333,
  "end_timestamp": 1703302428855,
  "transcript": "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",
  "message_with_tool_calls": [
    {
      "message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
      "role": "agent",
      "content": "hi how are you doing?",
      "created_timestamp": 1703302428855
    }
  ],
  "chat_cost": {
    "product_costs": [
      {
        "product": "elevenlabs_tts",
        "unit_price": 1,
        "cost": 60
      }
    ],
    "combined_cost": 70
  },
  "chat_analysis": {
    "chat_summary": "The agent messages user to ask question about his purchase inquiry. The agent asked several questions regarding his preference and asked if user would like to book an appointment. The user happily agreed and scheduled an appointment next Monday 10am.",
    "user_sentiment": "Positive",
    "chat_successful": true
  }
}

Changes

Changed in 4 of the 28 revisions of this API.2797

May 12, 20266dff2a12f8662See the full diff
- ▲
  the / response's property type changed from no type to string for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to string for status
  response-property-type-changed
Apr 20, 20268ee53928bf312595See the full diff
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the ///// response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the ///// response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the ///// response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the ///// response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the ///// response property allOf list for the response status
  response-property-all-of-added
Feb 23, 2026bcff6899fa2a1See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Feb 10, 20260bf5cea5dfcc1See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added

Full history