Skip to main content
PATCH
Update settings

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

If-Match
string | null

The ETag from your last read: the change is made only if the resource still has it, otherwise 412. Optional, except that a change replacing a list needs it (428 without it).

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The agent's ID.

Body

application/json

The settings to change. Only the fields sent change.

advanced
AgentAdvancedSettingsUpdate · object

Listening and response fine-tuning.

call
AgentCallSettingsUpdate · object

Timing and silence handling on calls.

compliance
AgentComplianceSettingsUpdate · object

Recording.

Response

Successful Response

How an agent handles calls: timing, recording and compliance, and fine-tuning.

advanced
AgentAdvancedSettings · object
required

Listening and response fine-tuning.

agent_id
string
required

The agent's ID.

call
AgentCallSettings · object
required

Timing and silence handling on calls.

compliance
AgentComplianceSettings · object
required

Recording and compliance.

object
string
default:agent_settings
required

The type of this object, always agent_settings.

Allowed value: "agent_settings"