Skip to content
PATCH /unified/crm/opportunities/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

accountobject

The opportunity's account

References: Accounts → id
14 supported1 required
Teamleader
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
idstring
required·

The account's unique identifier

amountnumber

The opportunity's amount

15 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
close_datestring · date-time

The date and time of the opportunity's close date

13 supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
close_time
1 supported
Pipedrive
supported
contactobject[]

The opportunity's contacts

References: Contacts → id
15 supported1 required
Teamleader
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring
required·

The contact's unique identifier

created_atstring · date-time

The date and time of the opportunity's creation

15 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
currencystring

The amount attribute's currency

9 supported
Attio
supported
Capsule
supported
Freshsales
supported
Insightly
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

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" }
15 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
descriptionstring

The opportunity's description

8 supported
Capsule
supported
Close
supported
HubSpot
supported
Insightly
supported
Keap
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
namestring

The opportunity's name

18 supported1 required
Teamleader
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
ownerobject

The opportunity's owner

16 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
idstring
required·

The opportunity's owner's unique identifier

remote_dataRecord<string, any>

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.

stageobject

The opportunity's stage

References: Stages → id
13 supported
Capsule
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
idstring

The stage's unique identifier

namestring

The stage's name

statusstring

The opportunity's status

Possible values:
leadin_progresswonlostopenlostwonabandonedallopenwonsuspended+ 6 more
9 supported
Attio
supported
leadin_progresswonlost
Highlevel
supported
openlostwonabandonedall
Insightly
supported
openwonsuspendedlostabandoned
Pipedrive
supported
openwonlostdeleted
Close
supported
Freshsales
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
tagsobject[]

The opportunity's tags

6 supported
Capsule
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Salesflare
supported
Zendesk Sell
supported
idstring

The tag's unique identifier

namestring

The tag's name

Response Body

idstring
required·

The opportunity's unique identifier

17 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
accountobject

The opportunity's account

References: Accounts → id
13 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
idstring

The account's unique identifier

amountnumber

The opportunity's amount

15 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
close_datestring · date-time

The date and time of the opportunity's close date

13 supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
contactobject[]

The opportunity's contacts

References: Contacts → id
14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The contact's unique identifier

created_atstring · date-time

The date and time of the opportunity's creation

15 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
currencystring

The amount attribute's currency

9 supported
Attio
supported
Capsule
supported
Freshsales
supported
Insightly
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

All the custom fields present on the opportunity

15 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
descriptionstring

The opportunity's description

8 supported
Capsule
supported
Close
supported
HubSpot
supported
Insightly
supported
Keap
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
last_activity_atstring · date-time

The date and time of the opportunity's last activity

10 supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Salesflare
supported
Zendesk Sell
supported
namestring

The opportunity's name

17 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
ownerobject

The opportunity's owner

16 supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
idstring

The opportunity's owner's unique identifier

remote_dataRecord<string, any>

Raw data returned from the remote API call.

stageobject

The opportunity's stage

References: Stages → id
13 supported
Capsule
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
idstring

The stage's unique identifier

namestring

The stage's name

statusstring

The opportunity's status

9 supported
Attio
supported
Close
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
tagsobject[]

The opportunity's tags

6 supported
Capsule
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Salesflare
supported
Zendesk Sell
supported
idstring

The tag's unique identifier

namestring

The tag's name

updated_atstring · date-time

The date and time of the opportunity's last update

14 supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
urlsobject[]

The opportunity's urls

7 supported
Attio
supported
Close
supported
Highlevel
supported
Monday CRM
supported
OnePageCRM
supported
Pipedrive
supported
Zendesk Sell
supported
typestring

The opportunity's URL type

urlstring

The opportunity's URL

curl -X PATCH 'https://api.truto.one/unified/crm/opportunities/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "your_name",
  "account": {},
  "contact": [],
  "status": "lead",
  "amount": 0,
  "owner": {},
  "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
  "description": "your_description",
  "stage": {},
  "currency": "your_currency",
  "tags": [],
  "close_date": "your_close_date",
  "created_at": "your_created_at",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "name": "your_name",
  "account": {},
  "contact": [],
  "status": "lead",
  "amount": 0,
  "owner": {},
  "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
  "description": "your_description",
  "stage": {},
  "currency": "your_currency",
  "tags": [],
  "close_date": "your_close_date",
  "created_at": "your_created_at",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/opportunities/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/crm/opportunities/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "name": "your_name",
    "account": {},
    "contact": [],
    "status": "lead",
    "amount": 0,
    "owner": {},
    "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
    "description": "your_description",
    "stage": {},
    "currency": "your_currency",
    "tags": [],
    "close_date": "your_close_date",
    "created_at": "your_created_at",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.update(
  'crm',
  'opportunities',
  '<resource_id>',
  {
  "name": "your_name",
  "account": {},
  "contact": [],
  "status": "lead",
  "amount": 0,
  "owner": {},
  "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
  "description": "your_description",
  "stage": {},
  "currency": "your_currency",
  "tags": [],
  "close_date": "your_close_date",
  "created_at": "your_created_at",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.update(
        "crm",
        "opportunities",
        "<resource_id>",
        {
        "name": "your_name",
        "account": {},
        "contact": [],
        "status": "lead",
        "amount": 0,
        "owner": {},
        "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
        "description": "your_description",
        "stage": {},
        "currency": "your_currency",
        "tags": [],
        "close_date": "your_close_date",
        "created_at": "your_created_at",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())