v2
phone-calls

Update Phone Call

Update a phone call record.

Note: In production, calls are updated by webhooks. This endpoint is primarily for testing purposes.

patch/v2/phone-calls/{call_id}

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

call_idstring required

Headers

mentium-workspace-idstring nullable

Request body

status'INITIATED' | 'RINGING' | 'ACTIVE' | 'COMPLETED' | 'FAILED' | 'NO_ANSWER' | 'BUSY'
answered_atstring date-time nullable
ended_atstring date-time nullable
duration_secondsinteger nullable
outcome'BOOKED' | 'NEGOTIATING' | 'REJECTED' | 'ERROR' | 'TRANSFERRED'
notesstring nullable
transcriptobject[] nullable
recording_urlstring nullable
conversation_idstring nullable

ElevenLabs conversation ID

twilio_call_sidstring nullable

Twilio call SID

ai_agent_idstring nullable

Internal Mentium ai_agent.id

elevenlabs_agent_idstring nullable

External ElevenLabs agent ID

external_reference_carrier_namestring nullable

Carrier display name snapshotted at call creation time

Response

Successful Response

idstring required
organization_idstring required
workspace_idstring required
direction'INBOUND' | 'OUTBOUND' required
status'INITIATED' | 'RINGING' | 'ACTIVE' | 'COMPLETED' | 'FAILED' | 'NO_ANSWER' | 'BUSY' required
from_numberstring required
to_numberstring required
external_reference_carrier_idstring nullable
external_reference_carrier_namestring nullable
external_reference_load_idstring nullable
ai_agent_idstring nullable
ai_agent_namestring nullable
ai_agent_revision_idstring nullable
ai_agent_revision_numberinteger nullable
elevenlabs_agent_idstring nullable
conversation_idstring nullable
twilio_call_sidstring nullable
carrier_offer_idstring nullable
initiated_atstring date-time required
answered_atstring date-time nullable
ended_atstring date-time nullable
duration_secondsinteger nullable
outcome'BOOKED' | 'NEGOTIATING' | 'REJECTED' | 'ERROR' | 'TRANSFERRED'
negotiated_ratestring nullable
negotiated_rate_currencystring nullable
notesstring nullable
recording_urlstring nullable
transfer_leg_sidstring nullable
transfer_leg_statusstring nullable
transfer_leg_duration_secondsinteger nullable
transfer_connected_atstring date-time nullable
post_transfer_transcriptobject[] nullable
post_transfer_transcription_terminal_resultstring nullable
post_transfer_recording_urlstring nullable
notes_spanning_transferstring nullable
transfer_resultstring nullable
transfer_detailstring nullable
transfer_notify_emailstring nullable
transfer_notify_namestring nullable
transfer_notify_phonestring nullable
transfer_sourcestring nullable
transcriptobject[] nullable
metadataobject nullable
estimated_cost_usdstring nullable
feedback_countinteger
latest_feedback_textstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.