Merge CRM - Opportunities

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

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified 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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

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

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

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

GET

/opportunities

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

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

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.

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

ActiveCampaign

Affinity

Capsule

Copper

HubSpot

Insightly

Microsoft Dynamics 365 Sales

Nutshell

Pipedrive

Pipeliner

Salesflare

Salesforce

SugarCRM

Teamleader

Teamwork CRM

Vtiger

Zendesk Sell

Zoho CRM

POST

/opportunities

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

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

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

ActiveCampaign

Capsule

HubSpot

Insightly

Microsoft Dynamics 365 Sales

Pipedrive

Salesforce

Teamleader

Vtiger

Zendesk Sell

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}

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.

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

ActiveCampaign

Affinity

Capsule

Copper

HubSpot

Insightly

Microsoft Dynamics 365 Sales

Nutshell

Pipedrive

Pipeliner

Salesflare

Salesforce

SugarCRM

Teamleader

Teamwork CRM

Vtiger

Zendesk Sell

Zoho CRM

PATCH

/opportunities/{id}

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

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

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Capsule

Copper

HubSpot

Pipedrive

Salesflare

Salesforce

Zoho CRM

GET

/opportunities/meta/patch/{id}

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

APAC

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

Copper

HubSpot

Pipedrive

Salesflare

Salesforce

Zoho CRM

GET

/opportunities/meta/post

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

APAC

Returns metadata for Opportunity POSTs.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

ActiveCampaign

Capsule

HubSpot

Insightly

Microsoft Dynamics 365 Sales

Pipedrive

Salesforce

Teamleader

Vtiger

Zendesk Sell

Zoho CRM

GET

/opportunities/remote-field-classes

Beta

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

APAC

Returns a list of RemoteFieldClass objects.

Query & Path Parameters

cursorString

Optional

The pagination cursor value.

include_deleted_dataBoolean

Optional

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

page_sizeInteger

Optional

Number of results to return per page.

Notes

Next Up

Get Started

API Reference

Previous

Next Up