Sign in

v2

latestOpenAPI 3.0.22026-08-07295198367.7 KB
Conversations

Patch Conversation Form Data

Update conversation form data.

patch/conversations/{conversation_id}/form-data

Path parameters

conversation_idstring uuid required

Query parameters

kb_idstring uuid
namestring
tokenstring required

Request body

input_namestring required

The name of the input field.

input_typestring required

The type of the input field.

input_labelstring required

The label of the input field.

input_placeholderstring required

The placeholder of the input field.

is_mandatoryboolean required

Flag indicating whether the input field is mandatory.

input_valuestring

The value of the input field.

Response

Successful Response

idstring uuid
date_createdstring date-time
date_updatedstring date-time
kb_idstring uuid

The ID of the knowledge base associated with the conversation.

namestring

The name of the conversation.

user_idstring uuid required

The ID of the user associated with the conversation.

has_not_answered_questionsboolean

Flag indicating whether this conversation has messages that are not answered.

agent_respondingboolean

Flag indicating whether an agent is currently responding to this conversation.

last_model_used'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4-omnimodel-mini' | 'gpt-4-omnimodel' | 'gpt-4-omnimodel-128k' | 'gpt-4-turbo' | 'gpt-4-turbo-128k' | 'gpt-4' | 'gpt-4-32k' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'falcon' | 'mistral' | 'wizardlm' | 'gemma' | 'llama2' | 'llama3' | 'llama3_8b' | 'cohere' | 'claude_3_opus_9k' | 'claude_3_opus_32k' | 'claude_3_opus_128k' | 'claude_3_opus_200k' | 'claude_3_sonnet' | 'claude_3_dot_5_sonnet' | 'claude_3_haiku' | 'claude_3_dot_7_sonnet' | 'claude_4_opus' | 'claude_4_sonnet' | 'gemini-2.0-flash' | 'gemini-2.5-flash' | 'gemini-2.0-flash-lite' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude_4_dot_5_sonnet' | 'claude_4_dot_1_opus' | 'claude_4_dot_5_haiku' | 'gemini-2.5-pro' | 'gemini-2.5-flash-lite' | 'gpt-5.1' | 'gemini-3-pro' | 'gpt-5.2' | 'gpt-5.4' | 'gemini-3-flash' | 'claude_4_dot_6_opus' | 'claude_4_6_sonnet' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'claude_4_7_opus' | 'claude_4_8_opus' | 'claude_5_opus' | 'claude_5_sonnet'

An enumeration.

intercom_idstring

The id of the conversation in intercom.

team_idstring uuid

The ID of the team associated with the conversation.