Opportunities
The Opportunity object is used to represent a deal opportunity in a CRM system.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
nameString
The opportunity's name.
descriptionString
The opportunity's description.
amountInteger
The opportunity's amount.
ownerUUID
The opportunity's owner.
accountUUID
The account of the opportunity.
stageUUID
The stage of the opportunity.
statusEnum
The opportunity's status. Possible values include: OPEN, WON, LOST. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
last_activity_atDateTime (ISO 8601)
When the opportunity's last activity occurred.
close_dateDateTime (ISO 8601)
When the opportunity was closed.
remote_created_atDateTime (ISO 8601)
When the third party's opportunity was created.
remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObject
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]
GET
/opportunities

https://api.merge.dev/api/crm/v1/opportunities

US
EU
APAC

Returns a list of Opportunity objects.


Query & path parameters
account_idString
Optional
If provided, will only return opportunities with this account.
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
owner_idString
Optional
If provided, will only return opportunities with this owner.
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
stage_idString
Optional
If provided, will only return opportunities with this stage.
statusString
Optional
If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
ActiveCampaign
ActiveCampaign
Affinity
Affinity
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Pipeliner
Pipeliner
Salesflare
Salesflare
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamleader
Teamleader
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
POST
/opportunities

https://api.merge.dev/api/crm/v1/opportunities

US
EU
APAC

Creates an Opportunity object with the given values.


Query & path parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.
nameString
The opportunity's name.
descriptionString
The opportunity's description.
amountInteger
The opportunity's amount.
ownerUUID
The opportunity's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.
accountUUID
The account of the opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.
stageUUID
The stage of the opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Stage object.
statusEnum
The opportunity's status. Must pass in one of the following choices: OPEN, WON, LOST.
last_activity_atDateTime (ISO 8601)
When the opportunity's last activity occurred.
close_dateDateTime (ISO 8601)
When the opportunity was closed.
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Capsule
Capsule
HubSpot
HubSpot
Insightly
Insightly
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Pipedrive
Pipedrive
Salesforce
Salesforce
Teamleader
Teamleader
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
To include the correct model fields when making POST requests, use the GET /opportunities/meta/post endpoint. Learn more in our /meta guide.
GET
/opportunities/{id}

https://api.merge.dev/api/crm/v1/opportunities/{id}

US
EU
APAC

Returns an Opportunity object with the given id.


Query & path parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
ActiveCampaign
ActiveCampaign
Affinity
Affinity
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Pipeliner
Pipeliner
Salesflare
Salesflare
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamleader
Teamleader
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
PATCH
/opportunities/{id}

https://api.merge.dev/api/crm/v1/opportunities/{id}

US
EU
APAC

Updates an Opportunity object with the given id.


Query & path parameters
idUUID
Required
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.
nameString
The opportunity's name.
descriptionString
The opportunity's description.
amountInteger
The opportunity's amount.
ownerUUID
The opportunity's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the Owner object.
accountUUID
The account of the opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.
stageUUID
The stage of the opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Stage object.
statusEnum
The opportunity's status. Must pass in one of the following choices: OPEN, WON, LOST.
last_activity_atDateTime (ISO 8601)
When the opportunity's last activity occurred.
close_dateDateTime (ISO 8601)
When the opportunity was closed.
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Capsule
Capsule
Copper
Copper
HubSpot
HubSpot
Pipedrive
Pipedrive
Salesflare
Salesflare
Salesforce
Salesforce
Zoho CRM
Zoho CRM
GET
/opportunities/meta/patch/{id}

https://api.merge.dev/api/crm/v1/opportunities/meta/patch/{id}

US
EU
APAC

Returns metadata for Opportunity PATCHs.


Query & path parameters
idUUID
Required
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Capsule
Capsule
Copper
Copper
HubSpot
HubSpot
Pipedrive
Pipedrive
Salesflare
Salesflare
Salesforce
Salesforce
Zoho CRM
Zoho CRM
GET
/opportunities/meta/post

https://api.merge.dev/api/crm/v1/opportunities/meta/post

US
EU
APAC

Returns metadata for Opportunity POSTs.


Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Capsule
Capsule
HubSpot
HubSpot
Insightly
Insightly
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Pipedrive
Pipedrive
Salesforce
Salesforce
Teamleader
Teamleader
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
GET
/opportunities/remote-field-classes
Beta

https://api.merge.dev/api/crm/v1/opportunities/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
Previous
Notes
Next Up
Stages