Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

Tasks.update

Modifies Task or Tasks with given id(s)

patch/entities/Tasks/{id}

Path parameters

idstring uuid required

ID of Task to update

Query parameters

validation-levelinteger

Specify validation level of Task 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

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

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 (e.g. Low, Normal, High, Urgent).

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, 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

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

Modification confirmation. Returns resulting Task

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "active_reminder": "2019-01-01T00:00:00",
    "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "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",
    "table_name": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}