Notes
TheNote object is used to represent a note in the remote system.The Note object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
ownerStringOptional
contentStringOptional
The note's content.
contactStringOptional
accountStringOptional
opportunityStringOptional
remote_updated_atStringOptional
When the third party's lead was updated.
remote_created_atStringOptional
When the third party's lead was created.
remote_dataRemoteData[]Optional
remote_was_deletedBooleanRequired
The Note object
JSON
{"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","content": "Merge is hiring!","contact": "025fjlc6-6000-430a-848e-aafacbadf4fe","account": "fba1fbc6-67c0-4cb2-a176-7896acd2ffd5","opportunity": "754a244e-dd67-4731-a8d3-9bff9dc10465","remote_updated_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/notes","data": ["Varies by platform"]}],"remote_was_deleted": true}
GET
/notes
Returns a list of Note 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 notes with this account.
contact_idStringOptional
If provided, will only return notes with this contact.
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.
opportunity_idStringOptional
If provided, will only return notes with this opportunity.
owner_idStringOptional
If provided, will only return notes with this owner.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","content": "Merge is hiring!","contact": "025fjlc6-6000-430a-848e-aafacbadf4fe","account": "fba1fbc6-67c0-4cb2-a176-7896acd2ffd5","opportunity": "754a244e-dd67-4731-a8d3-9bff9dc10465","remote_updated_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/notes","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
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atString
Close
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atString
Copper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contentStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atString
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atString
Pipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atString
Salesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/notes
Creates a Note 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.
ownerStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Owner table.contentStringOptional
The note's content.
contactStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Contact table.accountStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Account table.opportunityStringOptional
Must pass in a valid Merge ID, which can be obtained from the
id field in the Opportunity table.remote_updated_atStringOptional
When the third party's lead was updated.
remote_created_atStringOptional
When the third party's lead was created.
integration_paramsObjectOptional
linked_account_paramsObjectOptional
Response
JSON
{"model": {"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","content": "Merge is hiring!","contact": "025fjlc6-6000-430a-848e-aafacbadf4fe","account": "fba1fbc6-67c0-4cb2-a176-7896acd2ffd5","opportunity": "754a244e-dd67-4731-a8d3-9bff9dc10465","remote_updated_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/notes","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
/notes/{id}
Returns a Note 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.
Response
JSON
{"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","content": "Merge is hiring!","contact": "025fjlc6-6000-430a-848e-aafacbadf4fe","account": "fba1fbc6-67c0-4cb2-a176-7896acd2ffd5","opportunity": "754a244e-dd67-4731-a8d3-9bff9dc10465","remote_updated_at": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_data": [{"path": "/notes","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
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringClose
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringCopper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contentStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringHubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringPipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringSalesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/notes/meta/post
Returns metadata for Note 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
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringClose
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringCopper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contentStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringHubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringPipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringSalesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringcontentStringopportunityStringownerStringremote_created_atStringremote_dataRemoteData[]remote_idStringremote_updated_atStringHint: Use the /linked-accounts endpoint to pull platform support information.