fieldMapping

Field Mappings Partial Update

Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

patch/filestorage/v1/field-mappings/{field_mapping_id}

Request

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

Path parameters

field_mapping_idstring uuid required

Query parameters

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

remote_methodstring

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

remote_url_pathstring

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

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.