Update a list of mapping rules

PATCH

https://api.x.flatfile.com/v1/mapping/:programId/rules

PATCH

/v1/mapping/:programId/rules

1 curl -X PATCH 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     "createdAt": "2024-01-15T09:30:00Z",
8     "id": "id",
9     "name": "name",
10     "type": "type",
11     "updatedAt": "2024-01-15T09:30:00Z"
12   },
13   {
14     "createdAt": "2024-01-15T09:30:00Z",
15     "id": "id",
16     "name": "name",
17     "type": "type",
18     "updatedAt": "2024-01-15T09:30:00Z"
19   }
20 ]'

Try it

200Updated

1 {
2   "data": [
3     {
4       "createdAt": "2024-01-15T09:30:00Z",
5       "id": "id",
6       "name": "name",
7       "type": "type",
8       "updatedAt": "2024-01-15T09:30:00Z",
9       "acceptedAt": "2024-01-15T09:30:00Z",
10       "acceptedBy": "acceptedBy",
11       "confidence": 1,
12       "config": {
13         "key": "value"
14       },
15       "createdBy": "createdBy",
16       "deletedAt": "2024-01-15T09:30:00Z",
17       "metadata": {
18         "key": "value"
19       }
20     },
21     {
22       "createdAt": "2024-01-15T09:30:00Z",
23       "id": "id",
24       "name": "name",
25       "type": "type",
26       "updatedAt": "2024-01-15T09:30:00Z",
27       "acceptedAt": "2024-01-15T09:30:00Z",
28       "acceptedBy": "acceptedBy",
29       "confidence": 1,
30       "config": {
31         "key": "value"
32       },
33       "createdBy": "createdBy",
34       "deletedAt": "2024-01-15T09:30:00Z",
35       "metadata": {
36         "key": "value"
37       }
38     }
39   ]
40 }

Updates a list of mapping rules in a program

Delete a mapping rule

Updates a list of mapping rules in a program

Authentication

AuthorizationBearer

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

Path parameters

programIdstringRequired

ID of the program

Request

This endpoint expects a list of objects.

createdAtdatetimeRequired

Time the mapping rule was created

idstringRequired

ID of the mapping rule

namestringRequired

Name of the mapping rule

typestringRequired

updatedAtdatetimeRequired

Time the mapping rule was last updated

acceptedAtdatetimeOptional

Time the mapping rule was last updated

acceptedBystringOptional

User ID of the contributor of the mapping rule

confidenceintegerOptional

Confidence of the mapping rule

configanyOptional

createdBystringOptional

User ID of the user who suggested the mapping rule

deletedAtdatetimeOptional

Time the mapping rule was deleted

metadataanyOptional

Metadata of the mapping rule

Response

This endpoint returns an object.

datalist of objects

Errors