---
title: "Calls.update"
method: PATCH
path: "/entities/Calls/{id}"
tags: ["Call"]
---

# Calls.update

`PATCH /entities/Calls/{id}`

Modifies Call or Calls with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateCallInput
  - `oppty_product_relation` object — Specific opportunity line-item discussed on the call, when applicable. Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties.
    - `id` string, uri
  - `account_id` string, uuid — Id of the linked account.
  - `caller_id` string, uuid — Id of the calling user.
  - `client_id` string, uuid — Id of the user the call was made with.
  - `contact_id` string, uuid — Id of the linked contact.
  - `lead_oppty_id` string, uuid — Id of the linked lead or opportunity, or empty when not linked.
  - `oppty_product_relation_id` string, uuid — Id of the linked opportunity product line-item.
  - `phone_number` string — External phone number called or received, in E.164 format.
  - `product_id` string, uuid — Id of the linked product.
  - `transcription_id` string — External transcription identifier from the calling provider.
  - `transcription_language` string — Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
  - `transcription_summary` string — AI-generated summary of the call transcription.
  - `twilio_call_log_id` string, uuid — Id of the call-log record from the calling provider that this call is associated with.
  - `audio_status` 'NoRecording' | 'TranscriptionCompleted' | 'TranscriptionEmpty' | 'TranscriptionError' | 'TranscriptionInProgress' | 'UploadError' | 'Uploaded' | 'Uploading' — This is a small hack to force creation of MediaEntity upon Call creation. This field cannot be actually set. Instead, CallRepository.create method handles media creation, if requested.

## Response `200`

Modification confirmation. Returns resulting Call

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Call
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `account` string, uri — Account the call is linked to, when applicable. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.
    - `caller` string, uri, required — User who initiated the call. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `client` string, uri — User the call was made with, when the call was an internal user-to-user call. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `contact` string, uri — Contact the call is linked to, when applicable. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.
    - `lead` string, uri — Lead the call is linked to, when the call is associated with a lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.
    - `oppty` string, uri — Opportunity the call is linked to, when the call is associated with an opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.
    - `oppty_product_relation` string, uri — Specific opportunity line-item discussed on the call, when applicable. Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties.
    - `product` string, uri — Product discussed on the call, when applicable. Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties.
    - `account_id` string, uuid — Id of the linked account.
    - `caller_id` string, uuid, required — Id of the calling user.
    - `client_id` string, uuid — Id of the user the call was made with.
    - `contact_id` string, uuid — Id of the linked contact.
    - `lead_oppty_id` string, uuid — Id of the linked lead or opportunity, or empty when not linked.
    - `oppty_product_relation_id` string, uuid — Id of the linked opportunity product line-item.
    - `phone_number` string — External phone number called or received, in E.164 format.
    - `product_id` string, uuid — Id of the linked product.
    - `transcription_id` string — External transcription identifier from the calling provider.
    - `transcription_language` string — Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
    - `transcription_summary` string — AI-generated summary of the call transcription.
    - `twilio_call_log_id` string, uuid, required — Id of the call-log record from the calling provider that this call is associated with.
    - `transcription_file_id` string, uuid — Id of the cloud object holding the transcription payload, when available.
    - `audio_id` string, uuid — Id of the cloud object holding the call audio recording, when available.
    - `twilio_call_sid` string, required — External call identifier from the calling provider (e.g. Twilio Call SID).
    - `audio_status` 'NoRecording' | 'TranscriptionCompleted' | 'TranscriptionEmpty' | 'TranscriptionError' | 'TranscriptionInProgress' | 'UploadError' | 'Uploaded' | 'Uploading', required — This is a small hack to force creation of MediaEntity upon Call creation. This field cannot be actually set. Instead, CallRepository.create method handles media creation, if requested.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)