Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Task

Update Task

Update an existing 'Task' record.

patch/Task/{id}

Headers

X-Version-Numberstring

A version number for optimistic concurrency control. Obtained from the 'versionNumber' field.

Request body

idstring

An ID.

namestring

A one-line string.

status'Not Started' | 'Started' | 'Completed' | 'Canceled' | 'Deferred'
priority'Low' | 'Normal' | 'High' | 'Urgent'
dateStartstring nullable

Specified if the 'dateStart' field is all-day.

dateStartDatestring date nullable
dateEndstring nullable

Specified if the 'dateEnd' field is all-day.

dateEndDatestring date nullable
dateCompletedstring nullable

A timestamp in UTC.

descriptionstring nullable

A multi-line text.

parentIdstring nullable

A foreign record ID.

parentType'Account' | 'Contact' | 'Lead' | 'Opportunity' | 'Case' | 'CCompany' nullable

An entity type.

parentNamestring nullable

A foreign record name.

accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

collaboratorsIdsstring[] nullable

IDs of records of the User type.

collaboratorsNamesobject nullable

An {ID => record name} map.

streamUpdatedAtstring nullable

A timestamp in UTC.

Example request

{
  "dateStart": "2026-11-29 12:34:56",
  "dateEnd": "2026-11-29 12:34:56",
  "dateCompleted": "2026-11-29 12:34:56",
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

status'Not Started' | 'Started' | 'Completed' | 'Canceled' | 'Deferred'
priority'Low' | 'Normal' | 'High' | 'Urgent'
dateStartstring nullable

Specified if the 'dateStart' field is all-day.

dateStartDatestring date nullable
dateEndstring nullable

Specified if the 'dateEnd' field is all-day.

dateEndDatestring date nullable
dateCompletedstring nullable

A timestamp in UTC.

descriptionstring nullable

A multi-line text.

parentIdstring nullable

A foreign record ID.

parentType'Account' | 'Contact' | 'Lead' | 'Opportunity' | 'Case' | 'CCompany' nullable

An entity type.

parentNamestring nullable

A foreign record name.

accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

collaboratorsIdsstring[] nullable

IDs of records of the User type.

collaboratorsNamesobject nullable

An {ID => record name} map.

streamUpdatedAtstring nullable

A timestamp in UTC.

Example response

{
  "dateStart": "2026-11-29 12:34:56",
  "dateEnd": "2026-11-29 12:34:56",
  "dateCompleted": "2026-11-29 12:34:56",
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}