> ## Documentation Index > Fetch the complete documentation index at: https://docs.interactly.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml https://api-prod.interactly.ai/api-docs/campaigns/api.json patch /campaigns/v1/campaigns/{campaign_id}/calls/{call_id} openapi: 3.1.0 info: title: Interactly API description: API for building interactly.ai services version: 1.1.0 contact: name: Interactly url: https://interactly.ai email: developers@interactly.ai servers: - url: https://api-prod.interactly.ai description: API Server security: [] paths: /campaigns/v1/campaigns/{campaign_id}/calls/{call_id}: patch: tags: - Campaigns Calls - Campaign Calls summary: Update Call description: |- 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. operationId: >- campaigns_service_patch_call_by_call_id_v1_campaigns__campaign_id__calls__call_id__patch parameters: - name: campaign_id in: path required: true schema: $ref: '#/components/schemas/PydanticObjectId' description: Campaign configuration ID description: Campaign configuration ID - name: call_id in: path required: true schema: $ref: '#/components/schemas/PydanticObjectId' description: Call record ID description: Call record ID requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CampaignCallPatchRequest' responses: '200': description: Updated call record object content: application/json: schema: $ref: '#/components/schemas/CampaignCallDataResponse' '400': description: Bad request — invalid input or constraint violation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Requested resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer: [] components: schemas: PydanticObjectId: type: string maxLength: 24 minLength: 24 pattern: ^[0-9a-f]{24}$ example: 5eb7cf5a86d9755df3a6c593 CampaignCallPatchRequest: properties: status: anyOf: - type: string - type: 'null' title: Status description: >- 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: anyOf: - type: string - type: 'null' title: Reason description: Free-text reason for the status change or review decision errorCode: anyOf: - type: string - type: 'null' title: Errorcode description: Error code to attach when marking a call as failed errorMessage: anyOf: - type: string - type: 'null' title: Errormessage description: Human-readable error description when marking a call as failed collectedInformation: anyOf: - additionalProperties: true type: object - type: 'null' title: Collectedinformation description: >- Override or extend the structured data collected during the call conversation reviewStatus: anyOf: - type: string - type: 'null' title: Reviewstatus description: >- Set the manual review status. Possible values: 'not_required', 'pending', 'in_progress', 'rejected', 'approved' retry: type: boolean title: Retry description: >- When true, resets this call to 'ready' status so it is picked up for another dial attempt default: false reviewChecklist: additionalProperties: true type: object title: Reviewchecklist description: >- Key-value pairs for the review checklist (e.g. {"verified_insurance": true, "confirmed_dob": true}) tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: >- Replace the call's tag list with this list. Pass an empty list to clear all tags. type: object title: CampaignCallPatchRequest CampaignCallDataResponse: properties: message: type: string title: Message description: Result description examples: - Call fetched successfully. data: $ref: '#/components/schemas/CampaignCallResponse' description: Call record object type: object required: - message - data title: CampaignCallDataResponse ErrorResponse: properties: message: type: string title: Message description: Human-readable error description examples: - Resource not found. type: object required: - message title: ErrorResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CampaignCallResponse: properties: _id: anyOf: - type: string - type: 'null' title: Id description: Unique call record identifier configId: anyOf: - type: string - type: 'null' title: Configid description: ID of the campaign configuration this call belongs to phoneNumber: anyOf: - type: string - type: 'null' title: Phonenumber description: Target phone number for this call status: type: string title: Status description: >- Current call status. Possible values: 'received', 'ready', 'queued', 'ringing', 'processing', 'ended', 'completed', 'failed' default: received outcome: anyOf: - type: string - type: 'null' title: Outcome description: >- Call outcome label set by the AI assistant (e.g. 'conveyed', 'voicemail', 'no_answer', 'callback_requested') errorCode: anyOf: - type: string - type: 'null' title: Errorcode description: Error code when the call status is 'failed' errorMessage: anyOf: - type: string - type: 'null' title: Errormessage description: Human-readable error description when the call failed collectedInformation: additionalProperties: true type: object title: Collectedinformation description: >- Structured data collected by the AI assistant during the call conversation conversationId: anyOf: - type: string - type: 'null' title: Conversationid description: Unique conversation identifier assigned by the AI assistant platform retryCount: anyOf: - type: integer - type: 'null' title: Retrycount description: Number of retry attempts made for this call so far maxRetries: anyOf: - type: integer - type: 'null' title: Maxretries description: Maximum number of retry attempts allowed for this call tags: items: type: string type: array title: Tags description: Tags attached to this call for filtering review: anyOf: - $ref: '#/components/schemas/Review' - type: 'null' description: >- Manual review details. review.status values: 'not_required', 'pending', 'in_progress', 'rejected', 'approved' processTimings: anyOf: - $ref: >- #/components/schemas/campaigns_service__src__models__BenefitsVerificationCalls__ProcessTimings - type: 'null' description: 'Actual call execution timestamps: startAt and endAt (ISO 8601 UTC)' statusHistory: anyOf: - items: $ref: '#/components/schemas/StatusHistory-Output' type: array - type: 'null' title: Statushistory description: >- Chronological list of status transitions with timestamps and optional reasons createdAt: anyOf: - type: string format: date-time - type: 'null' title: Createdat description: UTC timestamp when this call record was created updatedAt: anyOf: - type: string format: date-time - type: 'null' title: Updatedat description: UTC timestamp of the most recent update to this call record type: object title: CampaignCallResponse description: Public-facing call fields returned in API responses. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError Review: properties: status: anyOf: - type: string - type: 'null' title: Status description: Review status default: not_required by: anyOf: - $ref: '#/components/schemas/PydanticObjectId' - type: 'null' description: Reviewer identifier timestamp: anyOf: - type: string format: date-time - type: 'null' title: Timestamp description: Review timestamp reason: anyOf: - type: string - type: 'null' title: Reason description: Review reason emails: items: type: string type: array title: Emails description: List of notification emails emailSent: anyOf: - type: boolean - type: 'null' title: Emailsent description: Whether notification email was sent default: false emailSentAt: anyOf: - type: string format: date-time - type: 'null' title: Emailsentat description: Timestamp of email sent checklist: additionalProperties: true type: object title: Checklist description: Review checklist items type: object title: Review description: Represents the review details for a call. campaigns_service__src__models__BenefitsVerificationCalls__ProcessTimings: properties: startAt: anyOf: - type: string format: date-time - type: 'null' title: Startat description: Process start timestamp endAt: anyOf: - type: string format: date-time - type: 'null' title: Endat description: Process end timestamp type: object title: ProcessTimings description: Presents the actual timings of the call process. StatusHistory-Output: properties: status: type: string title: Status description: Current status of the call timestamp: type: string format: date-time title: Timestamp description: Timestamp when status was updated reason: anyOf: - type: string - type: 'null' title: Reason description: Reason for status change type: object required: - status - timestamp title: StatusHistory description: Represents the history of status changes for a call. securitySchemes: bearer: scheme: bearer bearerFormat: Bearer type: http description: >- Retrieve your API Key from [Dashboard API Keys Section](https://dashboard.interactly.ai/api-keys). ````