COcoevera
Activity

Tasks.batch_create_or_update

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

post/entities/Tasks/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

media_transcription_idstring uuid

Id of the linked Media record holding the activity's call recording / transcription, when available.

activity_type_idstring uuid

Id of the task type.

call_durationinteger

Duration of the recorded call. Set automatically when the task is linked to a call log.

call_idstring uuid

Id of the linked call record.

call_outcome_idstring uuid

Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this task.

descriptionstring

Free-form description of what the task entails.

due_datestring date

Date by which the task is expected to be completed.

durationnumber double

Estimated duration of the task. Stored as a duration value (days/hours/minutes).

owner_idstring uuid

Id of the task owner.

priority1 | 2 | 3

Priority level of the task: Low, Medium or High.

Integer enum value: 1 - Low, 2 - Medium, 3 - High

share_mode0 | 1 | 2 | 3

Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

start_datestring date

Date when work on the task is scheduled to begin.

status1 | 2 | 3 | 4 | 5

Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.

Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred

subjectstring

Short summary line shown in lists and notifications.

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

exchange_entity_idstring

External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.

gapi_entity_idstring

External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.

o365_entity_idstring

External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.

call_sidstring

Identifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only.

idstring uuid

ID of object to update.

Example request

[
  {
    "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
    "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "call_duration": 1,
    "call_id": "01234567-abcd-dcba-ffff-000000000000",
    "call_outcome_id": "01234567-abcd-dcba-ffff-000000000000",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "due_date": "2019-01-01",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "priority": 1,
    "start_date": "2019-01-01",
    "status": 1,
    "subject": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "call_sid": "string"
  }
]

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.