Availability
Remote Fields is currently in Closed Beta for:
CRM - Read more about Remote Fields | CRM capabilities
Ticketing - Read more about Remote Fields | Ticketing capabilities
Please reach out if you're looking for support in additional categories.
Terminology
Remote Model - An entity on a CRM provider.
Example: A Deal on Hubspot is a Remote Model.
Remote Source Model - A Remote Model which maps to a Merge Common Model.
Example: A Deal on Hubspot is the Remote Source Model of the Opportunity Merge Common Model.
What are Remote Fields?
Where supported, Merge syncs and maps all fields from Remote Source Models in a standardized format, as fields on relevant Merge Common Model instances. This includes both standard and custom (user-defined) fields.
Merge also surfaces metadata about each Remote Field. This includes:
Information about the field type - string, bool, number, etc.
More granular information about string formats, if applicable - UUID, email, phone number, etc.
If applicable, available options - for picklists and other enumerations.
UX-related Metadata, like display name.
Whether the field is custom to the account, or standard to the 3rd-party provider
What can I do with Remote Fields?
With Remote Fields, you can:
Pull metadata and values for all fields from Remote Source Models in a standardized format, including standard and custom fields
Endpoint for reading Remote Field Classes from a Common Model : GET
https://api.merge.dev/api/crm/v1/{common_model_name}/remote-field-classesEndpoint for reading Remote Field Classes and values from Common Model instances: GET
https://api.merge.dev/api/crm/v1/{common_model_name}?include_remote_fields=TrueEndpoint for reading Remote Field Classes and values from a particular Common Model instance: GET
https://api.merge.dev/api/crm/v1/{common_model_name}/{id}?include_remote_fields=True
Push values for custom fields to your end-users’ CRM systems
You will use the relevant Merge POST endpoint for a particular Common Model, with your desired remote field values included in your request body.
Note: For pushing values for standard fields, you will use the standard Merge common model fields, or if needed, Linked Account parameters or Integration parameters.