Skip to content
POST /unified/crm/opportunities

Query Parameters

Refer Specifying query parameters in Truto APIs

workspaceobject
1 supported1 required
Highlevel
required
idstring
required
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.
  • 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.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

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
16 supported4 required
Pipeliner
required
Planhat
required
Salesflare
required
Teamleader
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Outreach
supported
Pipedrive
supported
Zendesk Sell
supported
idstring
required·

The account's unique identifier

amountnumber

The opportunity's amount

17 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
close_datestring · date-time

The date and time of the opportunity's close date

15 supported2 required
Outreach
required
Pipeliner
required
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
close_time
1 supported
Pipedrive
supported
contactobject[]

The opportunity's contacts

References: Contacts → id
17 supported5 required
Highlevel
required
Keap
required
OnePageCRM
required
Teamleader
required
Zendesk Sell
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Monday CRM
supported
Nimble
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
idstring
required·

The contact's unique identifier

created_atstring · date-time

The date and time of the opportunity's creation

17 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
currencystring

The amount attribute's currency

10 supported
Attio
supported
Capsule
supported
FowCRM
supported
Freshsales
supported
Insightly
supported
Nimble
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

Custom fields to be set on the opportunity

Example: { "custom_field_name_1": "foo", "custom_field_name_2": "bar" }
15 supported
Attio
supported
Capsule
supported
Close
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
descriptionstring

The opportunity's description

10 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
namestring

The opportunity's name

22 supported18 required
Affinity
required
Attio
required
Capsule
required
Freshsales
required
Highlevel
required
HubSpot
required
Insightly
required
Keap
required
Monday CRM
required
Nimble
required
OnePageCRM
required
Outreach
required
Pipedrive
required
Pipeliner
required
Salesforce
required
Teamleader
required
Zendesk Sell
required
Zoho CRM
required
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Planhat
supported
ownerobject

The opportunity's owner

18 supported2 required
Attio
required
Pipeliner
required
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
idstring
required·

The opportunity's owner's unique identifier

pipelineobject

The opportunity's pipeline.

1 supported1 required
Highlevel
required
idstring
required
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
16 supported5 required
Capsule
required
HubSpot
required
Keap
required
Pipeliner
required
Zoho CRM
required
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
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
11 supported2 required
Attio
required
leadin_progresswonlost
Highlevel
required
openlostwonabandonedall
Insightly
supported
openwonsuspendedlostabandoned
Pipedrive
supported
openwonlostdeleted
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
tagsobject[]

The opportunity's tags

7 supported
Capsule
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Nimble
supported
Zendesk Sell
supported
idstring

The tag's unique identifier

namestring

The tag's name

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

view_idstring

An unique identifier of the view that the new opportunity will be associated with. This view must be of type opportunity.

1 supported1 required
Affinity
required

Response Body

idstring
required·

The opportunity's unique identifier

20 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Zendesk Sell
supported
accountobject

The opportunity's account

References: Accounts → id
14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring

The account's unique identifier

amountnumber

The opportunity's amount

17 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
close_datestring · date-time

The date and time of the opportunity's close date

15 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
contactobject[]

The opportunity's contacts

References: Contacts → id
16 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nimble
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

17 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
currencystring

The amount attribute's currency

10 supported
Attio
supported
Capsule
supported
FowCRM
supported
Freshsales
supported
Insightly
supported
Nimble
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

All the custom fields present on the opportunity

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

The opportunity's description

10 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nimble
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
FowCRM
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Zendesk Sell
supported
namestring

The opportunity's name

19 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
ownerobject

The opportunity's owner

18 supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
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
15 supported
Capsule
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The stage's unique identifier

namestring

The stage's name

statusstring

The opportunity's status

11 supported
Attio
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
tagsobject[]

The opportunity's tags

7 supported
Capsule
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Nimble
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

16 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
FowCRM
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nimble
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
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

truto unified crm opportunities \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "name": "your_name",
  "account": {},
  "contact": [],
  "view_id": "your_view_id",
  "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",
  "urls": [],
  "pipeline": {},
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

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

const result = await truto.unifiedApi.create(
  'crm',
  'opportunities',
  {
  "name": "your_name",
  "account": {},
  "contact": [],
  "view_id": "your_view_id",
  "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",
  "urls": [],
  "pipeline": {},
  "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.create(
        "crm",
        "opportunities",
        {
        "name": "your_name",
        "account": {},
        "contact": [],
        "view_id": "your_view_id",
        "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",
        "urls": [],
        "pipeline": {},
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X POST 'https://api.truto.one/unified/crm/opportunities?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "your_name",
  "account": {},
  "contact": [],
  "view_id": "your_view_id",
  "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",
  "urls": [],
  "pipeline": {},
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "name": "your_name",
  "account": {},
  "contact": [],
  "view_id": "your_view_id",
  "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",
  "urls": [],
  "pipeline": {},
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/opportunities?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  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"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "name": "your_name",
    "account": {},
    "contact": [],
    "view_id": "your_view_id",
    "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",
    "urls": [],
    "pipeline": {},
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())