Skip to main content
PATCH
Update call analysis

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

What to change. Only the parts sent change; a list sent replaces the stored one, so send If-Match.

analytics_fields
AnalyticsFieldUpdate · object[]

All the custom fields: ones left out are removed. Up to 20, with Opportunity Analysis counted when it is set up.

Maximum array length: 20
opportunity_analysis
OpportunityAnalysisUpdate · object

Opportunity Analysis settings to change.

sentiment_definitions
SentimentDefinitionsUpdate · object

Sentiment definitions to change.

Response

Successful Response

What is worked out from each of an agent's calls after it ends.

agent_id
string
required

The agent's ID.

analytics_fields
AnalyticsField · object[]
required

The custom fields filled in for each call.

object
string
default:agent_call_analysis
required

The type of this object, always agent_call_analysis.

Allowed value: "agent_call_analysis"
opportunity_analysis
OpportunityAnalysis · object | null
required

What callers were after when they dropped off. null when it was never turned on.

sentiment_definitions
SentimentDefinitions · object
required

How call sentiment is judged.