Add mapping rules to a program

POST

1 curl -X POST https://api.x.flatfile.com/v1/mapping/programId/rules \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '[
6   {
7     "name": "name",
8     "type": "type"
9   },
10   {
11     "name": "name",
12     "type": "type"
13   }
14 ]'

Play

200Successful

1 {
2   "data": [
3     {
4       "createdAt": "2024-01-15T09:30:00Z",
5       "id": "id",
6       "updatedAt": "2024-01-15T09:30:00Z",
7       "confidence": 1,
8       "createdBy": "createdBy",
9       "deletedAt": "2024-01-15T09:30:00Z"
10     },
11     {
12       "createdAt": "2024-01-15T09:30:00Z",
13       "id": "id",
14       "updatedAt": "2024-01-15T09:30:00Z",
15       "confidence": 1,
16       "createdBy": "createdBy",
17       "deletedAt": "2024-01-15T09:30:00Z"
18     }
19   ]
20 }

Add mapping rules to a program

Path parameters

programIdstringRequired

ID of the program

Request

This endpoint expects a list of objects.

namestringRequired

Name of the mapping rule

typestringRequired

configanyOptional

acceptedAtdatetimeOptional

Time the mapping rule was last updated

acceptedBystringOptional

User ID of the contributor of the mapping rule

metadataanyOptional

Metadata of the mapping rule

Response

This endpoint returns an object.

datalist of objects

Add mapping rules to a program

Path parameters

Headers

Request

Response

Errors