fieldMapping

Field Mappings Create

Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

post/filestorage/v1/field-mappings

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/filestorage/v1/field-mappings
  • Auth: HTTP bearer

Query parameters

exclude_remote_field_metadataboolean

If true, remote fields metadata is excluded from each field mapping instance (i.e. remote_fields.remote_key_name and remote_fields.schema will be null). This will increase the speed of the request since these fields require some calculations.

remote_data_iteration_countinteger

Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.

Headers

X-Account-Tokenstring required

Token identifying the end user.

Request body

target_field_namestring

The name of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided.

target_field_descriptionstring

The description of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided.

organization_wide_target_fieldstring

The name or key of an existing Organization-wide target field to map to. When provided, target_field_name and target_field_description are optional.

is_integration_wideboolean

If true, creates an integration-wide field mapping that applies to all Linked Accounts for the integration. Requires organization_wide_target_field.

remote_methodstring required

The method of the remote endpoint where the remote field is coming from.

remote_url_pathstring required

The path of the remote endpoint where the remote field is coming from.

common_model_namestring required

The name of the Common Model that the remote field corresponds to in a given category.

jmes_pathstring

DEPRECATED: Use 'advanced_mapping_expression' instead.

advanced_mapping_expressionstring

A JSONata expression used to transform the remote field data.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.