Skip to main content
PATCH
Update Call

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

campaign_id
string
required

Campaign configuration ID

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

call_id
string
required

Call record ID

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json
status
string | null

Override the call status manually. Valid values for manual override: 'completed', 'failed'. Use only for correcting records where automated processing produced an incorrect result.

reason
string | null

Free-text reason for the status change or review decision

errorCode
string | null

Error code to attach when marking a call as failed

errorMessage
string | null

Human-readable error description when marking a call as failed

collectedInformation
Collectedinformation · object | null

Override or extend the structured data collected during the call conversation

reviewStatus
string | null

Set the manual review status. Possible values: 'not_required', 'pending', 'in_progress', 'rejected', 'approved'

retry
boolean
default:false

When true, resets this call to 'ready' status so it is picked up for another dial attempt

reviewChecklist
Reviewchecklist · object

Key-value pairs for the review checklist (e.g. {"verified_insurance": true, "confirmed_dob": true})

tags
string[] | null

Replace the call's tag list with this list. Pass an empty list to clear all tags.

Response

Updated call record object

message
string
required

Result description

Example:

"Call fetched successfully."

data
CampaignCallResponse · object
required

Call record object