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

nameString
Optional
The opportunity's name.

descriptionString
Optional
The opportunity's description.

amountInteger
Optional
The opportunity's amount.

ownerString
Optional
The opportunity's owner.

accountString
Optional
The account of the opportunity.

stageString
Optional
The stage of the opportunity.

statusEnum
Optional
The opportunity's status. Possible values include: OPEN, WON, LOST, or - in cases where there is no clear mapping - the original value passed through.

last_activity_atString
Optional
When the opportunity's last activity occurred.

close_dateString
Optional
When the opportunity was closed.

remote_created_atString
Optional
When the third party's opportunity was created.

remote_was_deletedBoolean
Required

idString
Required

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

field_mappingsObject
Optional

modified_atString
Required
This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]
Optional

remote_fieldsRemoteField[]
Required

The Opportunity object
JSON
{
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}

GET
/opportunities

Returns a list of Opportunity objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

account_idString
Optional
If provided, will only return opportunities with this account.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
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_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
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
Which fields should be returned in non-normalized form.

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')

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
]
}
Field support by platform
Accelo
Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Affinity
Affinity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Capsule
Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Close
Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Copper
Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
HubSpot
HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString

stageString

statusEnum
Insightly
Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Nutshell
Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Pipedrive
Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString

stageString

statusEnum
Pipeliner
Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Salesflare
Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Salesforce
Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString

stageString

statusEnum
SugarCRM
SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Teamleader
Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Teamwork CRM
Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Vtiger
Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Zendesk Sell
Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Zoho CRM
Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST
/opportunities

Creates an Opportunity object with the given values.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
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.

ownerString
The opportunity's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.

accountString
The account of the opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

stageString
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_atString
When the opportunity's last activity occurred.

close_dateString
When the opportunity was closed.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

POST v1/opportunities
JSON
{
"model": {
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z"
}
}
Response
JSON
{
"model": {
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
}
Field support by platform
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

descriptionString
Optional

last_activity_atString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Capsule
Capsule

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

descriptionString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional
HubSpot
HubSpot

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

last_activity_atString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Insightly
Insightly

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

last_activity_atString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional
Pipedrive
Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

last_activity_atString
Optional

nameString
Required

ownerString
Optional

remote_created_atString
Optional

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Salesforce
Salesforce

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Required

descriptionString
Optional

last_activity_atString
Optional

nameString
Required

ownerString
Optional

remote_created_atString
Optional

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Optional

stageString
Required

statusEnum
Optional
Teamleader
Teamleader

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Zendesk Sell
Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

last_activity_atString
Optional

nameString
Required

ownerString
Required

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional
Zoho CRM
Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

last_activity_atString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/opportunities/{id}

Returns an Opportunity object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
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
Which fields should be returned in non-normalized form.

Response
JSON
{
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
Field support by platform
Accelo
Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Affinity
Affinity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Capsule
Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Close
Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Copper
Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
HubSpot
HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString

stageString

statusEnum
Insightly
Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Nutshell
Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Pipedrive
Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString

stageString

statusEnum
Pipeliner
Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Salesflare
Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Salesforce
Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString

stageString

statusEnum
SugarCRM
SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Teamleader
Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Teamwork CRM
Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString

statusEnum
Vtiger
Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Zendesk Sell
Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Zoho CRM
Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

amountInteger

close_dateString

descriptionString

last_activity_atString

nameString

ownerString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

stageString
Hint: Use the /linked-accounts endpoint to pull platform support information.
PATCH
/opportunities/{id}

Updates an Opportunity object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

idString
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.

ownerString
The opportunity's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the Owner object.

accountString
The account of the opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

stageString
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_atString
When the opportunity's last activity occurred.

close_dateString
When the opportunity was closed.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

PATCH v1/opportunities/{id}
JSON
{
"model": {
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z"
}
}
Response
JSON
{
"model": {
"name": "Needs Integrations",
"description": "Needs a Unified API for Integrations!",
"amount": 100000,
"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
"status": "WON",
"last_activity_at": "2022-02-10T00:00:00Z",
"close_date": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
}
Field support by platform
Capsule
Capsule

Merge supports Passthrough Requests to this platform's API

Supported PATCH Model Parameters


amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

stageString
Optional
Copper
Copper

Merge supports Passthrough Requests to this platform's API

Supported PATCH Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

descriptionString
Optional

nameString
Optional

ownerString
Optional

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Pipedrive
Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported PATCH Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

last_activity_atString
Optional

nameString
Optional

ownerString
Optional

stageString
Optional

statusEnum
Optional
Salesflare
Salesflare

Merge supports Passthrough Requests to this platform's API

Supported PATCH Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

last_activity_atString
Optional

nameString
Optional

ownerString
Optional

remote_created_atString
Optional

remote_idString
Optional

stageString
Optional

statusEnum
Optional
Zoho CRM
Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported PATCH Model Parameters


accountString
Optional

amountInteger
Optional

close_dateString
Optional

descriptionString