Skip to main content
PUT
Update Omni Flow Agent

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Path Parameters

string
required
The unique identifier of the agent to update

Request Body

string
New name for the agent
string
New language model to use
object

Response Fields

string
The unique identifier for the OmniFlowAgent.
string
The identifier of the workspace where the OmniFlowAgent is configured.
string
The identifier of the user associated with the OmniFlowAgent, if any.
string
The name of the OmniFlowAgent.
string
The language model used by the OmniFlowAgent, such as ‘gpt-4o-mini’.
string
The identifier of the phone number associated with the OmniFlowAgent.
object
A flexible schema for storing custom settings related to the OmniFlowAgent.
string
The operational status of the OmniFlowAgent, such as ‘pending’, ‘ready’, or ‘error’.
string
Timestamp when the conversation was created.
string
Timestamp when the conversation was last updated.