Appearance

Update Opportunities ​

Endpoint ​

http
PATCH /unified/crm/opportunities/{id}
Integrations supported
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • 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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
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

Request Body ​

Refer Writing data using Unified APIs

name
string

The opportunity's name

Required in
  • Teamleader
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
account
object

The opportunity's account

References: Accounts → id
Required in
  • Teamleader
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Insightly
  • Outreach
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Zoho CRM
id
string
REQUIRED · 

The account's unique identifier

contact
object[]

The opportunity's contacts

References: Contacts → id
Required in
  • Teamleader
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The contact's unique identifier

status
string

The opportunity's status

All possible enum values:
  • lead
  • in_progress
  • won
  • lost
  • open
  • abandoned
  • all
  • suspended
  • deleted
Enum support by integration
  • Attio
    • lead
    • in_progress
    • won
    • lost
  • Highlevel
    • open
    • lost
    • won
    • abandoned
    • all
  • Insightly
    • open
    • won
    • suspended
    • lost
    • abandoned
  • Pipedrive
    • open
    • won
    • lost
    • deleted
Supported in
  • Attio
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • Insightly
  • OnePageCRM
  • Pipedrive
  • Planhat
amount
number

The opportunity's amount

Supported in
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
owner
object

The opportunity's owner

Supported in
  • Attio
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The opportunity's owner's unique identifier

custom_fields
object

Custom fields to be set on the contact. The custom_fields object will be a key-value pair, where the key will be the name attribute of the custom field found in the response of https://truto.one/docs/api-reference/unified-crm-api/fields/list endpoint.

Example: { "custom_field_name_1": "foo", "custom_field_name_2": "bar" }
Supported in
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
description
string

The opportunity's description

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • OnePageCRM
  • Outreach
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zoho CRM
stage
object

The opportunity's stage

References: Stages → id
Supported in
  • Capsule
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The stage's unique identifier

name
string

The stage's name

currency
string

The amount attribute's currency

Supported in
  • Capsule
  • Insightly
  • Planhat
  • Teamleader
  • Zendesk Sell
tags
object[]

The opportunity's tags

Supported in
  • Capsule
  • Freshsales
  • Salesflare
  • Zendesk Sell
  • Zoho CRM
id
string

The tag's unique identifier

name
string

The tag's name

close_date
string · date-time

The date and time of the opportunity's close date

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zoho CRM
created_at
string · date-time

The date and time of the opportunity's creation

Supported in
  • Close
close_time
Supported in
  • Pipedrive
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 opportunity's unique identifier

Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
name
string

The opportunity's name

Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
description
string

The opportunity's description

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • OnePageCRM
  • Outreach
  • Pipeliner
amount
number

The opportunity's amount

Supported in
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
currency
string

The amount attribute's currency

Supported in
  • Attio
  • Capsule
  • Freshsales
  • Insightly
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
owner
object

The opportunity's owner

Supported in
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
id
string

The opportunity's owner's unique identifier

account
object

The opportunity's account

References: Accounts → id
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Insightly
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
id
string

The account's unique identifier

contact
object[]

The opportunity's contacts

References: Contacts → id
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
id
string

The contact's unique identifier

stage
object

The opportunity's stage

References: Stages → id
Supported in
  • Capsule
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
id
string

The stage's unique identifier

name
string

The stage's name

status
string

The opportunity's status

Supported in
  • Attio
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • Insightly
  • OnePageCRM
  • Pipedrive
  • Pipeliner
  • Planhat
tags
object[]

The opportunity's tags

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • Insightly
  • Salesflare
  • Zendesk Sell
id
string

The tag's unique identifier

name
string

The tag's name

custom_fields
object

All the custom fields present on the opportunity

Supported in
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Zendesk Sell
last_activity_at
string · date-time

The date and time of the opportunity's last activity

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • Insightly
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Salesflare
  • Zendesk Sell
close_date
string · date-time

The date and time of the opportunity's close date

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
created_at
string · date-time

The date and time of the opportunity's creation

Supported in
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
updated_at
string · date-time

The date and time of the opportunity's last update

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • OnePageCRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
urls
object[]

The opportunity's urls

Supported in
  • Attio
  • Close
  • Highlevel
  • Monday CRM
  • OnePageCRM
  • Pipedrive
  • Zendesk Sell
url
string

The opportunity's URL

type
string

The opportunity's URL type

remote_data
object

Raw data returned from the remote API call.