Mapping

Update a list of mapping rules

PATCH
Updates a list of mapping rules in a program

Path parameters

programIdstringRequired
ID of the program

Request

This endpoint expects a list of objects.
createdAt
datetimeRequired
Time the mapping rule was created
id
stringRequired
ID of the mapping rule
name
stringRequired
Name of the mapping rule
type
stringRequired
updatedAt
datetimeRequired
Time the mapping rule was last updated
acceptedAt
datetimeOptional
Time the mapping rule was last updated
acceptedBy
stringOptional
User ID of the contributor of the mapping rule
confidence
integerOptional
Confidence of the mapping rule
config
anyOptional
createdBy
stringOptional
User ID of the user who suggested the mapping rule
deletedAt
datetimeOptional
Time the mapping rule was deleted

Response

This endpoint returns an object
data
list of objects

Errors

PATCH
$curl -X PATCH https://api.x.flatfile.com/v1/mapping/%3AprogramId/rules \
>     -H "X-Disable-Hooks: true" \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "createdAt": "2023-01-01T00:00:00Z",
>    "id": "string",
>    "name": "string",
>    "type": "string",
>    "updatedAt": "2023-01-01T00:00:00Z"
>  }
>]'
Response
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    }
16  ]
17}
Built with