Skip to content

Update Opportunities

Endpoint

http
PATCH /unified/crm/opportunities/{id}
Integrations supported
  • Salesforce

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. Defaults to `unified`. `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.
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.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

name
string
The opportunity's name
Supported in
  • Salesforce
description
string
The opportunity's description
Supported in
  • Salesforce
amount
number
The opportunity's amount
Supported in
  • Salesforce
owner
object
The opportunity's owner
Supported in
  • Salesforce
id
string
The opportunity's owner's unique identifier
account
object
The opportunity's account
Supported in
  • Salesforce
id
string
The account's unique identifier
contact
object[]
The opportunity's contacts
Supported in
  • Salesforce
id
string
The contact's unique identifier
stage
object
The opportunity's stage
Supported in
  • Salesforce
id
string
The stage's unique identifier
name
string
The stage's name
close_date
string · date-time
The date and time of the opportunity's close date
Supported in
  • Salesforce
custom_fields
Supported in
  • Salesforce
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 note's unique identifier
name
string
The opportunity's name
description
string
The opportunity's description
amount
number
The opportunity's amount
currency
string
The amount attribute's currency
owner
object
The opportunity's owner
id
string
The opportunity's owner's unique identifier
account
object
The opportunity's account
id
string
The account's unique identifier
contact
object[]
The opportunity's contacts
id
string
The contact's unique identifier
stage
object
The opportunity's stage
id
string
The stage's unique identifier
name
string
The stage's name
status
string
The opportunity's status
tags
object[]
The opportunity's tags
id
string
The tag's unique identifier
name
string
The tag's name
last_activity_at
string · date-time
The date and time of the opportunity's last activity
close_date
string · date-time
The date and time of the opportunity's close date
created_at
string · date-time
The date and time of the opportunity's creation
updated_at
string · date-time
The date and time of the opportunity's last update
remote_data
object
Raw data returned from the remote API call.