/field-mappings/{field_mapping_id}

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");

{
  "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",
    "advanced_mapping_expression": "$[0].example_jsonata"
  },
  "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/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these 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.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

field_mapping_idstringRequiredformat: "uuid"

Response

modelobject

warningslist of objects

errorslist of objects

logslist of objects or null

Authentication

Path parameters

Headers

Response