Appearance

Update Tasks ​

Endpoint ​

http
PATCH /unified/crm/tasks/{id}
Integrations supported
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
contact
array

The task's contact

Required in
  • Highlevel

Request Body ​

Refer Writing data using Unified APIs

owner
object

The task's owner

Supported in
  • Capsule
  • Close
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The owner's unique identifier

name
string

The owner's name

content
string

The task's content

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
due_date
string · date-time

The date and time of the task's due date

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
status
string

The task's status

All possible enum values:
  • open
  • completed
  • closed
  • none
  • deferred
  • waiting
  • not started
Enum support by integration
  • Close
    • open
    • closed
  • Pipedrive
    • open
    • closed
  • Capsule
    • open
    • completed
  • Wix
    • open
    • completed
    • none
  • Insightly
    • open
    • completed
    • deferred
    • waiting
    • not started
  • Keap
    • completed
    • open
  • Highlevel
    • open
    • completed
Supported in
  • Capsule
  • Close
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Planhat
  • Salesforce
  • Wix
  • Zendesk Sell
  • Zoho CRM
subject
string

The task's subject

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zoho CRM
completed_at
string · date-time

The date and time of the task's completion

Supported in
  • Capsule
  • HubSpot
  • Zoho CRM
account
object

The task's account

Supported in
  • Capsule
  • Freshsales
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
id
string

The account's unique identifier

contact
object[]

The task's contact

Supported in
  • Capsule
  • Freshsales
  • Keap
  • Outreach
  • Pipedrive
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
id
string

The contact's unique identifier

name
string

The contact's name

opportunity
object[]

The task's opportunity

Supported in
  • Freshsales
  • Insightly
  • Pipedrive
  • Salesforce
  • Teamleader
  • Zendesk Sell
id
string

The opportunity's unique identifier

name
string

The opportunity's name

priority
Supported in
  • Salesforce
custom_fields
Supported in
  • Insightly
  • Planhat
  • Salesforce
lead
object[]

The task's lead

Supported in
  • Salesforce
  • Zendesk Sell
id
string

The lead's unique identifier

name
string

The lead's name

owner_id
Supported in
  • Freshsales
type
object

The task's type

Supported in
  • Planhat
  • Teamleader
id
string

The type's unique identifier

name
string

The type's name

description
Supported in
  • Wix
etag
string

The unique identifier for the specific version of the resource.

Required in
  • Wix
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The task's unique identifier

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
  • Zendesk Sell
subject
string

The task's subject

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Planhat
  • Wix
content
string

The task's content

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
  • Zendesk Sell
type
object

The task's type

Supported in
  • Capsule
  • Keap
  • Planhat
id
string

The type's unique identifier

name
string

The type's name

owner
object

The task's owner

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
  • Zendesk Sell
id
string

The owner's unique identifier

name
string

The owner's name

account
object

The task's account

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
id
string

The account's unique identifier

contact
object[]

The task's contact

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Wix
  • Zendesk Sell
id
string

The contact's unique identifier

name
string

The contact's name

opportunity
object[]

The task's opportunity

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Pipedrive
  • Zendesk Sell
id
string

The opportunity's unique identifier

name
string

The opportunity's name

lead
object[]

The task's lead

Supported in
  • Close
  • Zendesk Sell
id
string

The lead's unique identifier

name
string

The lead's name

completed_at
string · date-time

The date and time of the task's completion

Supported in
  • Capsule
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
due_date
string · date-time

The date and time of the task's due date

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Wix
  • Zendesk Sell
status
string

The task's status

All possible enum values:
  • open
  • completed
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
  • Zendesk Sell
created_at
string · date-time

The date and time of the task's creation

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
  • Zendesk Sell
updated_at
string · date-time

The date and time of the task's last update

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
  • Zendesk Sell
etag
string

The unique identifier for the specific version of the resource.

Supported in
  • Wix
remote_data
object

Raw data returned from the remote API call.