Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
Files
Guests
Jobs
Mapping
POST
Create a mapping between two schemas
DEL
Delete all history for the authenticated user
GET
List mapping programs
GET
Get a mapping program
PATCH
Update a mapping program
DEL
Delete a mapping program
POST
Add mapping rules to a program
DEL
Delete multiple mapping rules
GET
List mapping rules
GET
Get a mapping rule
PATCH
Update a mapping rule
PATCH
Update a list of mapping rules
DEL
Delete a mapping rule
Records
Roles
Secrets
Sheets
Snapshots
Spaces
Users
Versions
Views
Workbooks
Community
Create Account
Sign in
API Reference
Mapping
Create a mapping between two schemas
POST
https://api.x.flatfile.com/v1
/
mapping
Creates a list of mapping rules based on two provided schemas
Request
This endpoint expects an object.
source
object
Required
Source schema
Show 11 properties
destination
object
Required
Destination schema
Show 11 properties
familyId
string
Optional
ID of the family to add the program to
namespace
string
Optional
Namespace of the program
save
boolean
Optional
Whether to save the program for editing later. Defaults to false. If true, the response will contain an ID and access token.
Response
This endpoint returns an object.
data
object
Show 10 properties
Errors
400
Bad Request
404
Not Found
Built with