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

# Tasks.update

`PATCH /entities/Tasks/{id}`

Modifies Task or Tasks with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateTaskInput
  - `media_transcription_id` string, uuid — Id of the linked Media record holding the activity's call recording / transcription, when available.
  - `activity_type_id` string, uuid — Id of the task type.
  - `call_duration` integer — Duration of the recorded call. Set automatically when the task is linked to a call log.
  - `call_id` string, uuid — Id of the linked call record.
  - `call_outcome_id` string, uuid — Id of the call outcome value.
  - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this task.
  - `description` string — Free-form description of what the task entails.
  - `due_date` string, date — Date by which the task is expected to be completed.
  - `duration` number, double — Estimated duration of the task. Stored as a duration value (days/hours/minutes).
  - `owner_id` string, uuid — Id of the task owner.
  - `priority` 1 | 2 | 3 — Priority level of the task (e.g. Low, Normal, High, Urgent). Integer enum value: 1 - Low, 2 - Medium, 3 - High
  - `share_mode` 0 | 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_date` string, date — Date when work on the task is scheduled to begin.
  - `status` 1 | 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
  - `subject` string — Short summary line shown in lists and notifications.
  - `unit_id` string, uuid — Id of the sales unit.
  - `revision` integer — Revision when entity was lastly changed.
  - `sharing_units` object[] — Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing.
    - `id` string, uri
  - `sharing_clients` object[] — Users that have been granted shared access to this task. Editable only when share_mode allows user sharing.
    - `id` string, uri
  - `account_relations` object[] — Accounts this task is linked to.
    - `id` string, uri
  - `contact_relations` object[] — Contacts this task is linked to.
    - `id` string, uri
  - `lead_relations` object[] — Leads this task is linked to.
    - `id` string, uri
  - `opportunity_relations` object[] — Opportunities this task is linked to.
    - `id` string, uri
  - `project_relations` object[] — Projects this task is linked to, including the per-objective ordering.
    - `id` string, uri
  - `quote_relations` object[] — Quotes this task is linked to.
    - `id` string, uri
  - `custom_entity_relations` object[] — Custom entity records this task is linked to.
    - `id` string, uri
  - `exchange_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
  - `gapi_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
  - `o365_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
  - `task_recurrence` object — Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Relation to TaskRecurrence, see: 'updateTaskRecurrenceInput' object for properties.
    - `id` string, uri
  - `documents` object[] — Documents linked to this task.
    - `id` string, uri
  - `comments` object[] — Comments authored on this task.
    - `id` string, uri
  - `tags` object[] — Tag labels applied to this task.
    - `id` string, uri
  - `call_sid` string

## Response `200`

Modification confirmation. Returns resulting Task

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Task
    - `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.
    - `active_reminder` string, date-time — Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending.
    - `media_transcription_id` string, uuid — Id of the linked Media record holding the activity's call recording / transcription, when available.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `activity_type` string, uri, required — Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties.
    - `call` string, uri — Call record associated with this task when the task represents a phone call. Relation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties.
    - `call_outcome` string, uri — Configurable outcome of the call (e.g. Reached, Voicemail, No Answer). Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.
    - `currency_exchange_rates_list` string, uri — Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.
    - `owner` string, uri — Sales user who owns this task. May be empty when the task is unassigned and available for take-over. 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.
    - `unit` string, uri, required — Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.
    - `activity_type_id` string, uuid — Id of the task type.
    - `call_duration` integer — Duration of the recorded call. Set automatically when the task is linked to a call log.
    - `call_id` string, uuid — Id of the linked call record.
    - `call_outcome_id` string, uuid — Id of the call outcome value.
    - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this task.
    - `description` string — Free-form description of what the task entails.
    - `due_date` string, date — Date by which the task is expected to be completed.
    - `duration` number, double — Estimated duration of the task. Stored as a duration value (days/hours/minutes).
    - `owner_id` string, uuid — Id of the task owner.
    - `priority` 1 | 2 | 3 — Priority level of the task (e.g. Low, Normal, High, Urgent). Integer enum value: 1 - Low, 2 - Medium, 3 - High
    - `share_mode` 0 | 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_date` string, date — Date when work on the task is scheduled to begin.
    - `status` 1 | 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
    - `subject` string, required — Short summary line shown in lists and notifications.
    - `table_name` string, required — Discriminator identifying the concrete record type — always "task" for Task records. Read-only; useful when consuming polymorphic Activity results.
    - `unit_id` string, uuid — Id of the sales unit.
    - `revision` integer — Revision when entity was lastly changed.
    - `sharing_units` string[] — Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing.
    - `sharing_clients` string[] — Users that have been granted shared access to this task. Editable only when share_mode allows user sharing.
    - `account_relations` string[] — Accounts this task is linked to.
    - `contact_relations` string[] — Contacts this task is linked to.
    - `lead_relations` string[] — Leads this task is linked to.
    - `opportunity_relations` string[] — Opportunities this task is linked to.
    - `project_relations` string[] — Projects this task is linked to, including the per-objective ordering.
    - `quote_relations` string[] — Quotes this task is linked to.
    - `custom_entity_relations` string[] — Custom entity records this task is linked to.
    - `exchange_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
    - `gapi_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
    - `o365_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
    - `reminder` string, uri — Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. Relation to TaskReminder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskReminder' object for properties.
    - `task_recurrence` string, uri — Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Relation to TaskRecurrence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskRecurrence' object for properties.
    - `documents` string[] — Documents linked to this task.
    - `comments` string[] — Comments authored on this task.
    - `tags` string[] — Tag labels applied to this task.
    - `formatted_name` string, required — Display name of the task (alias of subject).
    - `modified_by_user` string, date-time — Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.

## 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/versions/e8c12ae60aca/schema)