Call

Calls.batch_create_or_update

Creates or updates Call records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/Calls/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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'

Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.