For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Opportunity object
          • GET/opportunities
          • POST/opportunities
          • GET/opportunities/{id}
          • PATCH/opportunities/{id}
          • GET/opportunities/meta/patch/{id}
          • GET/opportunities/meta/post
          • GET/opportunities/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsOpportunities

The Opportunity object

The Opportunity Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "description": "string",
8  "amount": 0,
9  "owner": "string",
10  "account": "string",
11  "stage": "string",
12  "status": "OPEN",
13  "last_activity_at": "2023-01-01T00:00:00Z",
14  "close_date": "2023-01-01T00:00:00Z",
15  "remote_created_at": "2023-01-01T00:00:00Z",
16  "remote_was_deleted": true,
17  "field_mappings": {},
18  "remote_data": [
19    {
20      "path": "string",
21      "data": {}
22    }
23  ],
24  "remote_fields": [
25    {
26      "remote_field_class": {
27        "id": "string",
28        "display_name": "string",
29        "remote_key_name": "string",
30        "description": "string",
31        "is_custom": true,
32        "is_common_model_field": true,
33        "is_required": true,
34        "field_type": "string",
35        "field_format": "string",
36        "field_choices": [
37          "string"
38        ],
39        "item_schema": {
40          "item_type": "string",
41          "item_format": "string",
42          "item_choices": [
43            "string"
44          ]
45        }
46      },
47      "value": {
48        "string": {}
49      }
50    }
51  ]
52}
Was this page helpful?
Previous

/notes/remote-field-classes

Next

/opportunities

Built with

The Opportunity object is used to represent a deal opportunity in a CRM system.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The opportunity's name.
descriptionstring or nullOptional
The opportunity's description.
amountinteger or nullOptional-2147483648-2147483647
The opportunity's amount.
ownerstring or nullOptionalformat: "uuid"
The opportunity's owner.
accountstring or nullOptionalformat: "uuid"
The account of the opportunity.
stagestring or nullOptionalformat: "uuid"
The stage of the opportunity.
statusenum or nullOptional
Allowed values:
last_activity_atdatetime or nullOptional
When the opportunity's last activity occurred.
close_datedatetime or nullOptional
When the opportunity was closed.
remote_created_atdatetime or nullOptional
When the third party's opportunity was created.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only