Opportunities
TheOpportunity object is used to represent an opportunity in the remote system.The Opportunity object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The opportunity's name.
descriptionStringOptional
The opportunity's description.
amountIntegerOptional
The opportunity's amount.
ownerStringOptional
accountStringOptional
stageStringOptional
statusEnumOptional
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_atStringOptional
When the opportunity's last activity occurred.
close_dateStringOptional
When the opportunity was closed.
remote_created_atStringOptional
When the third party's opportunity was created.
remote_dataRemoteData[]Optional
remote_was_deletedBooleanRequired
The Opportunity object
JSON
{"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","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_data": [{"path": "/opportunities","data": ["Varies by platform"]}],"remote_was_deleted": true}
GET
/opportunities
Returns a list of Opportunity objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
account_idStringOptional
If provided, will only return opportunities with this account.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
owner_idStringOptional
If provided, will only return opportunities with this owner.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Which fields should be returned in non-normalized form.
remote_idStringOptional
The API provider's ID for the given object.
stage_idStringOptional
If provided, will only return opportunities with this stage.
statusStringOptional
If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","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_data": [{"path": "/opportunities","data": ["Varies by platform"]}],"remote_was_deleted": true}]}
Field support by platform
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageString
Close
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageString
Copper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageString
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageString
Pipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringlast_activity_atStringnameStringownerStringremote_dataRemoteData[]remote_idStringstageString
Salesflare
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringstatusEnum
Salesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/opportunities
Creates an Opportunity object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The opportunity's name.
descriptionStringOptional
The opportunity's description.
amountIntegerOptional
The opportunity's amount.
ownerStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Owner table.accountStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Account table.stageStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Stage table.statusEnumOptional
The opportunity's status. Must pass in one of the following choices:
OPEN, WON, LOST.last_activity_atStringOptional
When the opportunity's last activity occurred.
close_dateStringOptional
When the opportunity was closed.
remote_created_atStringOptional
When the third party's opportunity was created.
integration_paramsObjectOptional
linked_account_paramsObjectOptional
Response
JSON
{"model": {"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","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_data": [{"path": "/opportunities","data": ["Varies by platform"]}],"remote_was_deleted": true},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}
GET
/opportunities/{id}
Returns an Opportunity object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","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_data": [{"path": "/opportunities","data": ["Varies by platform"]}],"remote_was_deleted": true}
Field support by platform
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringClose
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringCopper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringHubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringPipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringlast_activity_atStringnameStringownerStringremote_dataRemoteData[]remote_idStringstageStringSalesflare
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringstatusEnumSalesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/opportunities/meta/post
Returns metadata for Opportunity POSTs.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Response
JSON
{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
Field support by platform
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringClose
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringCopper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringHubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringPipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringlast_activity_atStringnameStringownerStringremote_dataRemoteData[]remote_idStringstageStringSalesflare
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringstatusEnumSalesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringamountIntegerclose_dateStringdescriptionStringlast_activity_atStringnameStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringstageStringHint: Use the /linked-accounts endpoint to pull platform support information.