Sign in

v2

latestOpenAPI 3.1.02026-07-273779120.8 KB
Campaigns Calls
Campaign Calls

Update Call

Patch a call by its ID in a campaign.

  • campaign_id: The ID of the campaign configuration.
  • call_id: The ID of the call to patch.
  • body: The request body containing fields to update.
patch/campaigns/v1/campaigns/{campaign_id}/calls/{call_id}

Path parameters

campaign_idstring required
Example:5eb7cf5a86d9755df3a6c593

Campaign configuration ID

call_idstring required
Example:5eb7cf5a86d9755df3a6c593

Call record ID

Request body

statusstring nullable

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

reasonstring nullable

Free-text reason for the status change or review decision

errorCodestring nullable

Error code to attach when marking a call as failed

errorMessagestring nullable

Human-readable error description when marking a call as failed

collectedInformationobject nullable

Override or extend the structured data collected during the call conversation

reviewStatusstring nullable

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

retryboolean

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

reviewChecklistobject

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

tagsstring[] nullable

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

Response

Updated call record object

messagestring required

Result description

Example response

{
  "message": "Call fetched successfully.",
  "data": {
    "review": {
      "by": "5eb7cf5a86d9755df3a6c593"
    }
  }
}