Update a list of mapping rules

PATCH

Updates a list of mapping rules in a program

Path parameters

programIdstringRequired

ID of the program

Headers

X-Disable-Hooks"true"Required

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

PATCH

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": "2023-01-01T00:00:00Z",
8     "id": "string",
9     "name": "string",
10     "type": "string",
11     "updatedAt": "2023-01-01T00:00:00Z"
12   }
13 ]'

1 {
2   "data": [
3     {
4       "createdAt": "2023-01-01T00:00:00Z",
5       "id": "string",
6       "name": "string",
7       "type": "string",
8       "updatedAt": "2023-01-01T00:00:00Z",
9       "acceptedAt": "2023-01-01T00:00:00Z",
10       "acceptedBy": "string",
11       "confidence": 0,
12       "config": {},
13       "createdBy": "string",
14       "deletedAt": "2023-01-01T00:00:00Z",
15       "metadata": {}
16     }
17   ]
18 }

Built with

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": "2023-01-01T00:00:00Z",
8	"id": "string",
9	"name": "string",
10	"type": "string",
11	"updatedAt": "2023-01-01T00:00:00Z"
12	}
13	]'

1	{
2	"data": [
3	{
4	"createdAt": "2023-01-01T00:00:00Z",
5	"id": "string",
6	"name": "string",
7	"type": "string",
8	"updatedAt": "2023-01-01T00:00:00Z",
9	"acceptedAt": "2023-01-01T00:00:00Z",
10	"acceptedBy": "string",
11	"confidence": 0,
12	"config": {},
13	"createdBy": "string",
14	"deletedAt": "2023-01-01T00:00:00Z",
15	"metadata": {}
16	}
17	]
18	}