/field-mappings

curl -X POST https://api.merge.dev/api/knowledgebase/v1/field-mappings \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "target_field_name": "example_target_field_name",
  "target_field_description": "this is a example description of the target field",
  "remote_field_traversal_path": [
    "example_remote_field"
  ],
  "remote_method": "GET",
  "remote_url_path": "/example-url-path",
  "common_model_name": "ExampleCommonModel"
}'

{
  "model": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_integration_wide": true,
    "target_field": {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_organization_wide": true
    },
    "remote_field": {
      "remote_key_name": "example_remote_field_key",
      "schema": {
        "type": "string"
      },
      "remote_endpoint_info": {
        "method": "GET",
        "url_path": "/example-url-path",
        "field_traversal_path": [
          "example_remote_field_key"
        ]
      }
    },
    "jmes_path": "[0].example_jmes_path"
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

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.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

exclude_remote_field_metadatabooleanOptional

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.

Request

This endpoint expects an object.

target_field_namestringRequired>=1 character

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

target_field_descriptionstringRequired>=1 character

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

remote_field_traversal_pathlist of anyRequired

The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.

remote_methodstringRequired>=1 character

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

remote_url_pathstringRequired>=1 character

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

common_model_namestringRequired>=1 character

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

jmes_pathstringOptional>=1 character

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

Response

modelobject

warningslist of objects

errorslist of objects

logslist of objects or null

Authentication

Headers

Query parameters

Request

Response