Create a mapping between two schemas

curl -X POST https://api.x.flatfile.com/v1/mapping \
     -H "X-Disable-Hooks: true" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "source": {
    "name": "name",
    "fields": [
      {
        "type": "string",
        "key": "key"
      },
      {
        "type": "string",
        "key": "key"
      }
    ]
  },
  "destination": {
    "name": "name",
    "fields": [
      {
        "type": "string",
        "key": "key"
      },
      {
        "type": "string",
        "key": "key"
      }
    ]
  }
}'

{
  "data": {
    "rules": [
      {
        "name": "name",
        "type": "type",
        "acceptedAt": "2024-01-15T09:30:00Z",
        "acceptedBy": "acceptedBy",
        "confidence": 1,
        "config": {
          "key": "value"
        },
        "createdAt": "2024-01-15T09:30:00Z",
        "createdBy": "createdBy",
        "deletedAt": "2024-01-15T09:30:00Z",
        "id": "id",
        "metadata": {
          "key": "value"
        },
        "updatedAt": "2024-01-15T09:30:00Z"
      },
      {
        "name": "name",
        "type": "type",
        "acceptedAt": "2024-01-15T09:30:00Z",
        "acceptedBy": "acceptedBy",
        "confidence": 1,
        "config": {
          "key": "value"
        },
        "createdAt": "2024-01-15T09:30:00Z",
        "createdBy": "createdBy",
        "deletedAt": "2024-01-15T09:30:00Z",
        "id": "id",
        "metadata": {
          "key": "value"
        },
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "sourceKeys": [
      "sourceKeys",
      "sourceKeys"
    ],
    "destinationKeys": [
      "destinationKeys",
      "destinationKeys"
    ],
    "id": "id",
    "namespace": "namespace",
    "familyId": "familyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "createdBy",
    "summary": {
      "totalRuleCount": 1,
      "addedRuleCount": 1,
      "deletedRuleCount": 1
    },
    "accessToken": "accessToken",
    "acceptedAt": "2024-01-15T09:30:00Z",
    "acceptedBy": "acceptedBy"
  }
}

Creates a list of mapping rules based on two provided schemas

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

environmentIdstringOptional

The ID of the environment

Request

This endpoint expects an object.

sourceobjectRequired

Source schema

destinationobjectRequired

Destination schema

familyIdstringOptional

ID of the family to add the program to

namespacestringOptional

Namespace of the program

savebooleanOptional

Whether to save the program for editing later. Defaults to false. If true, the response will contain an ID and access token.

ruleslist of objectsOptional

Mapping rules to use for the program. If present, the program will be created with these rules.

Response

This endpoint returns an object.

dataobject

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Headers

Query parameters

Request

Response

Errors

Authentication

Headers

Query parameters

Request

Response

Errors