Notes
The Note object is used to represent a note on another object.
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.
ownerUUID
Optional
The note's owner.
contentString
Optional
The note's content.
contactUUID
Optional
The note's contact.
accountUUID
Optional
The note's account.
opportunityUUID
Optional
The note's opportunity.
remote_updated_atDateTime (ISO 8601)
Optional
When the third party's lead was updated.
remote_created_atDateTime (ISO 8601)
Optional
When the third party's lead 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
/notes

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

US
EU
APAC

Returns a list of Note objects.


Query & Path Parameters
account_idString
Optional
If provided, will only return notes with this account.
contact_idString
Optional
If provided, will only return notes with this contact.
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
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.
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.
opportunity_idString
Optional
If provided, will only return notes with this opportunity.
owner_idString
Optional
If provided, will only return notes with this owner.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
Affinity
Affinity
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Keap
Keap
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Pipeliner
Pipeliner
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamwork CRM
Teamwork CRM
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
POST
/notes

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

US
EU
APAC

Creates a Note 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.
ownerUUID
The note's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.
contentString
The note's content.
contactUUID
The note's contact. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.
accountUUID
The note's account. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.
opportunityUUID
The note's opportunity. Must pass in a valid Merge ID, which can be obtained from the id field in the Opportunity object.
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
HubSpot
HubSpot
Pipedrive
Pipedrive
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
To include the correct model fields when making POST requests, use the GET /notes/meta/post endpoint. Learn more in our /meta guide.
GET
/notes/{id}

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

US
EU
APAC

Returns a Note 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.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
Affinity
Affinity
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Keap
Keap
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Pipeliner
Pipeliner
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamwork CRM
Teamwork CRM
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
GET
/notes/meta/post

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

US
EU
APAC

Returns metadata for Note POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
HubSpot
HubSpot
Pipedrive
Pipedrive
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
GET
/notes/remote-field-classes
Beta

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

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & Path Parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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.
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.
Previous
Leads
Next Up
Opportunities