Appearance

Update Opportunities ​

Endpoint ​

http
PATCH /unified/crm/opportunities/{id}
Integrations supported
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • 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 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

Request Body ​

Refer Writing data using Unified APIs

account
object

The opportunity's account

Required in
  • Teamleader
Supported in
  • Capsule
  • Close
  • Freshsales
  • Insightly
  • Outreach
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Zoho CRM
id
string

The account's unique identifier

name
string

The opportunity's name

Required in
  • Teamleader
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
amount
number

The opportunity's amount

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
owner
object

The opportunity's owner

Supported in
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The opportunity's owner's unique identifier

close_date
string · date-time

The date and time of the opportunity's close date

Supported in
  • Capsule
  • Close
  • HubSpot
  • Insightly
  • Keap
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zoho CRM
custom_fields
object

Custom fields to be set on the opportunity

Example: { "custom_field_name_1": "foo", "custom_field_name_2": "bar" }
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
created_at
string · date-time

The date and time of the opportunity's creation

Supported in
  • Close
stage
object

The opportunity's stage

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The stage's unique identifier

name
string

The stage's name

description
string

The opportunity's description

Supported in
  • Capsule
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zoho CRM
contact
object[]

The opportunity's contacts

Required in
  • Teamleader
Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • Keap
  • Outreach
  • Pipedrive
  • Salesforce
  • Zendesk Sell
id
string

The contact's unique identifier

status
string

The opportunity's status

All possible enum values:
  • open
  • won
  • lost
  • deleted
  • suspended
  • abandoned
  • all
Enum support by integration
  • Pipedrive
    • open
    • won
    • lost
    • deleted
  • Insightly
    • open
    • won
    • suspended
    • lost
    • abandoned
  • Highlevel
    • open
    • lost
    • won
    • abandoned
    • all
Supported in
  • Highlevel
  • Insightly
  • Pipedrive
  • Planhat
close_time
Supported in
  • Pipedrive
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
id
string

The tag's unique identifier

name
string

The tag's name

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
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
name
string

The opportunity's name

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
description
string

The opportunity's description

Supported in
  • Capsule
  • Close
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipeliner
amount
number

The opportunity's amount

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
currency
string

The amount attribute's currency

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

The opportunity's owner

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

The opportunity's owner's unique identifier

account
object

The opportunity's account

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
id
string

The account's unique identifier

contact
object[]

The opportunity's contacts

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

The contact's unique identifier

stage
object

The opportunity's stage

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • 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
  • Close
  • Freshsales
  • Highlevel
  • Insightly
  • 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
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • 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
  • Outreach
  • Pipedrive
  • Salesflare
  • Zendesk Sell
close_date
string · date-time

The date and time of the opportunity's close date

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
created_at
string · date-time

The date and time of the opportunity's creation

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • 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
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
urls
object[]

The opportunity's urls

Supported in
  • Highlevel
  • Pipedrive
url
string

The opportunity's URL

type
string

The opportunity's URL type

remote_data
object

Raw data returned from the remote API call.