Introduction
Merge retrieves data from each third-party platform and normalizes that data into common models. In most cases, you don't need to worry about the nuances of every field in every platform but there may be some scenarios where you'll have to. Maybe your customer uses a custom BambooHR field named "Family Name" instead of the default "Last Name" field. Or maybe you disagree with the way Merge has mapped a field for a given integration. For scenarios like these, Merge allows you to change these default mappings through the Override Common Model Field feature.
The Common Model override feature only supports GET use cases. If a Common Model field is overridden, you will no longer be able to POST data to that field.
How to Override a Common Model Field for a Specific Linked Account
Typically used when your customer uses a custom or "user-defined" field specific to their instance rather than the default field.
Navigate to the specific Linked Account you will be overriding a common model field for.
Under the Field Mapping tab, find the Common Model Overrides section.
Select the + Common Model override button at the bottom of the section
Note, this may initially say "Loading origin fields" when navigating to this page. This means Merge is compiling the possible fields that exist in the third-party system. This process can take a few seconds.
After selecting the button, a new override config will appear as shown below.
First, select the Common Model to override in the top left corner of the config then select the specific field you are looking to override right below it.
You will then be able to select the third-party field in the right-most section of the config.
Note, a sample value will be shown in the example field. If you know the field you are looking for, you can filter the results by typing!
After selecting the third-party field, select Save to save the config!
That's it! The next time Merge syncs with the third-party application, the specified third-party field will be used instead of Merge's default mappings.
How to Override a Common Model Field Across All Linked Accounts
Typically used when Merge has not yet mapped a field for a given integration or you'd like to override a default Merge mapping.
Navigate to the Advanced > Field Mappings page within your Merge Dashboard.
Under the Common Model overrides section, select the + Common Model field button.
After selecting the button, populate the Common Model and field you'd like to override and select Save.
The override configuration will then be created. To populate the third-party platform mappings select the newly created configuration.
You will be taken to the overrides page for the given config. Find the integration(s) you'd like to set the override for and select the + Common Model override button. Choose the field you'd like to see the override to.
Note, you may see "No matches found" for some integrations. See the FAQs section at the bottom of this guide for more information about this scenario.
A pop-up will appear asking you to confirm the override and letting you know you will no longer be able to POST to this field. Select Override Field if you are comfortable with this.
That's it! Any newly created linked account will use the specified third-party field rather than Merge's default mapping. For any existing linked accounts, the next time Merge syncs with the third-party application, the specified third-party field will be used instead of Merge's default mapping.
Common Model Override FAQs
"I'd like to use the Common Model override feature for the POSTing of data"
Merge currently only supports the feature for the fetching of data. You will no longer be able to use any Common Model fields that are overridden when POSTing.
"I'm not seeing any third-party field in the dropdown when trying to create an override across all Linked Accounts"
The fields listed are the ones returned in 95% of all Production Linked Accounts in Merge. Any integration that does not have 25 Production Linked Accounts will not show any fields as available for Integration Wide Field Mappings.
"I'm not seeing any third-party field in the dropdown when trying to create an override for a specific Linked Accounts".
The fields listed are ones that appear within remote data for the given Common Model. It may be that remote data does not exist for the given Common Model.
"I'm looking for a specific third-party field that I know exists for a given Linked Account but that field is not showing up as an option to map".
The only fields listed are ones that appear within remote data for the given Common Model. The ability to override common model fields with third-party fields that are related to other objects such as Custom Objects is not currently supported.