--- title: "Update a call" method: PATCH path: "/uc/{connection_id}/call/{id}" tags: ["uc", "call"] --- # Update a call `PATCH /uc/{connection_id}/call/{id}` ## Request - Base URL: `https://api.unified.to` - URL: `https://api.unified.to/uc/{connection_id}/call/{id}` - Auth: API key in header `authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Updates the UcCall identified by `id`. Provide the unified UcCall fields to change in the request body. ## Path parameters - `connection_id` string, required - `id` string, required ## Query parameters - `fields` string[] - `raw` string ## Request body - UcCall - `id` string: Unique identifier for this call object - `created_at` string, date-time: The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `updated_at` string, date-time: The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `contact_id` string: The contact ID for call (reference to UcContact) - `telephone` PropertyUcCallTelephone: The telephone number called - `telephone` string, required - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE' - `start_at` string, date-time: The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `end_at` string, date-time: The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `user_id` string: (reference to HrisEmployee) - `contacts` UcContact[] - `id` string: Unique identifier for this contact object - `created_at` string, date-time: The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `updated_at` string, date-time: The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `name` string: The name of the contact - `first_name` string - `last_name` string - `title` string: The job title of the contact - `company` string: The company/organization name of the contact - `emails` UcEmail[]: An array of email addresses for this contact - `email` string, required - `type` 'WORK' | 'HOME' | 'OTHER' - `telephones` UcTelephone[]: An array of telephones for this contact - `telephone` string, required - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE' - `metadata` UcMetadata[] - `id` string - `slug` string - `value` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `namespace` string - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL' - `extra_data` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `raw` object: The raw data returned by the integration for this contact - `is_private` boolean - `user_name` string - `user_phone` string - `type` 'INBOUND' | 'OUTBOUND' - `metadata` UcMetadata[] - `id` string - `slug` string - `value` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `namespace` string - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL' - `extra_data` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `raw` object: The raw data returned by the integration for this call - `conversation_identifier` string: opaque identifier shared across legs of one interaction - `status` 'QUEUED' | 'RINGING' | 'IN_PROGRESS' | 'COMPLETED' | 'BUSY' | 'NO_ANSWER' | 'FAILED' | 'CANCELED' | 'OTHER': The current or final status of the call - `answer_at` string, date-time: When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `duration_seconds` number: Call length in seconds - `cost_amount` number: What the integration charged for the call - `currency` string: ISO 4217 currency of cost_amount - `parent_id` string: The parent call (leg) that this call belongs to - `instructions` UcCallInstruction[]: Write-only: what the call does once answered (create/update only; never returned) - `type` 'SAY' | 'PLAY' | 'PAUSE' | 'DIAL' | 'HANGUP', required - `text` string: SAY: text to speak - `language` string: SAY: BCP 47 language code (e.g. en-US), passed to the integration as-is - `audio_url` string: PLAY: public MP3 or WAV URL - `seconds` number: PAUSE: length of silence - `telephone` PropertyUcCallInstructionTelephone: DIAL: number to dial and bridge - `telephone` string, required - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE' - `sip_uri` string: DIAL: SIP address to dial instead of telephone - `user_phone` string: DIAL: caller ID on the dialed leg (defaults to the call's user_phone) - `timeout_seconds` number: DIAL: how long to ring before giving up ## Response `200` Successful - UcCall - `id` string: Unique identifier for this call object - `created_at` string, date-time: The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `updated_at` string, date-time: The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `contact_id` string: The contact ID for call (reference to UcContact) - `telephone` PropertyUcCallTelephone: The telephone number called - `telephone` string, required - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE' - `start_at` string, date-time: The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `end_at` string, date-time: The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `user_id` string: (reference to HrisEmployee) - `contacts` UcContact[] - `id` string: Unique identifier for this contact object - `created_at` string, date-time: The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `updated_at` string, date-time: The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `name` string: The name of the contact - `first_name` string - `last_name` string - `title` string: The job title of the contact - `company` string: The company/organization name of the contact - `emails` UcEmail[]: An array of email addresses for this contact - `email` string, required - `type` 'WORK' | 'HOME' | 'OTHER' - `telephones` UcTelephone[]: An array of telephones for this contact - `telephone` string, required - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE' - `metadata` UcMetadata[] - `id` string - `slug` string - `value` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `namespace` string - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL' - `extra_data` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `raw` object: The raw data returned by the integration for this contact - `is_private` boolean - `user_name` string - `user_phone` string - `type` 'INBOUND' | 'OUTBOUND' - `metadata` UcMetadata[] - `id` string - `slug` string - `value` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `namespace` string - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL' - `extra_data` union - object - string - number - boolean - union[] - union - object - string - number - boolean - `raw` object: The raw data returned by the integration for this call - `conversation_identifier` string: opaque identifier shared across legs of one interaction - `status` 'QUEUED' | 'RINGING' | 'IN_PROGRESS' | 'COMPLETED' | 'BUSY' | 'NO_ANSWER' | 'FAILED' | 'CANCELED' | 'OTHER': The current or final status of the call - `answer_at` string, date-time: When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) - `duration_seconds` number: Call length in seconds - `cost_amount` number: What the integration charged for the call - `currency` string: ISO 4217 currency of cost_amount - `parent_id` string: The parent call (leg) that this call belongs to - `instructions` UcCallInstruction[]: Write-only: what the call does once answered (create/update only; never returned) - `type` 'SAY' | 'PLAY' | 'PAUSE' | 'DIAL' | 'HANGUP', required - `text` string: SAY: text to speak - `language` string: SAY: BCP 47 language code (e.g. en-US), passed to the integration as-is - `audio_url` string: PLAY: public MP3 or WAV URL - `seconds` number: PAUSE: length of silence - `telephone` PropertyUcCallInstructionTelephone: DIAL: number to dial and bridge - `telephone` string, required - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE' - `sip_uri` string: DIAL: SIP address to dial instead of telephone - `user_phone` string: DIAL: caller ID on the dialed leg (defaults to the call's user_phone) - `timeout_seconds` number: DIAL: how long to ring before giving up ## Changes - **2026-10-23** `46c96cdb9630`: 1 info - endpoint added [Operation history](https://skmtc.dev/unified/apis/unified-to-api/changes/uc/:connection_id/call/:id/patch.md) --- [API](https://skmtc.dev/unified/apis/unified-to-api.md) - [All operations](https://skmtc.dev/unified/apis/unified-to-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api/revisions/122e36e8450a?raw)