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

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

nameString
Optional
The opportunity's name.

descriptionString
Optional
The opportunity's description.

amountInteger
Optional
The opportunity's amount.

ownerUUID
Optional
The opportunity's owner.

accountUUID
Optional
The account of the opportunity.

stageUUID
Optional
The stage of the opportunity.

statusEnum
Optional
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.

last_activity_atDateTime (ISO 8601)
Optional
When the opportunity's last activity occurred.

close_dateDateTime (ISO 8601)
Optional
When the opportunity was closed.

remote_created_atDateTime (ISO 8601)
Optional
When the third party's opportunity was created.

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

remote_fieldsRemoteField[]
Required


GET
/opportunities

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

US
EU

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
Whether to include data that was marked as deleted by third party webhooks.

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.

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.

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
See all supported fields
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

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
See all supported fields
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

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.

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
See all supported fields
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

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
See all supported fields
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

Returns metadata for Opportunity PATCHs.


Query & Path Parameters

idUUID
Required
Field support by integration
See all supported fields
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

Returns metadata for Opportunity POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Capsule
Capsule