Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Call

Calls.update

Modifies Call or Calls with given id(s)

patch/entities/Calls/{id}

Path parameters

idstring uuid required

ID of Call to update

Query parameters

validation-levelinteger

Specify validation level of Call on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the linked account.

caller_idstring uuid

Id of the calling user.

client_idstring uuid

Id of the user the call was made with.

contact_idstring uuid

Id of the linked contact.

lead_oppty_idstring uuid

Id of the linked lead or opportunity, or empty when not linked.

oppty_product_relation_idstring uuid

Id of the linked opportunity product line-item.

phone_numberstring

External phone number called or received, in E.164 format.

product_idstring uuid

Id of the linked product.

transcription_idstring

External transcription identifier from the calling provider.

transcription_languagestring

Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").

transcription_summarystring

AI-generated summary of the call transcription.

twilio_call_log_idstring 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.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "caller_id": "01234567-abcd-dcba-ffff-000000000000",
  "client_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
  "phone_number": "string",
  "product_id": "01234567-abcd-dcba-ffff-000000000000",
  "transcription_id": "string",
  "transcription_language": "string",
  "transcription_summary": "string",
  "twilio_call_log_id": "01234567-abcd-dcba-ffff-000000000000",
  "audio_status": "NoRecording"
}

Response

Modification confirmation. Returns resulting Call

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "caller_id": "01234567-abcd-dcba-ffff-000000000000",
    "client_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone_number": "string",
    "product_id": "01234567-abcd-dcba-ffff-000000000000",
    "transcription_id": "string",
    "transcription_language": "string",
    "transcription_summary": "string",
    "twilio_call_log_id": "01234567-abcd-dcba-ffff-000000000000",
    "transcription_file_id": "01234567-abcd-dcba-ffff-000000000000",
    "audio_id": "01234567-abcd-dcba-ffff-000000000000",
    "twilio_call_sid": "string",
    "audio_status": "NoRecording"
  }
}