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/knowledgebase/v1/field-mappings

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/knowledgebase/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.

Headers

X-Account-Tokenstring required

Token identifying the end user.

Request body

target_field_namestring required

The name of the target field you want this remote field to map to.

target_field_descriptionstring required

The description of the target field you want this remote field to map to.

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

JMES path to specify json query expression to be used on field mapping.

Response

Changes

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