Mapping

Update a mapping rule

PATCH
Updates a mapping rule in a program

Path parameters

programIdstringRequired
ID of the program
mappingIdstringRequired
ID of mapping rule

Request

This endpoint expects an object.
name
stringRequired
Name of the mapping rule
type
stringRequired
config
anyOptional
acceptedAt
datetimeOptional
Time the mapping rule was last updated
acceptedBy
stringOptional
User ID of the contributor of the mapping rule

Response

This endpoint returns an object
data
object

Errors

PATCH
$curl -X PATCH https://api.x.flatfile.com/v1/mapping/us_mp_YOUR_ID/rules/us_mr_YOUR_ID \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Assign mapping rule",
>  "type": "assign",
>  "config": {}
>}'
Response
1{
2  "data": {
3    "createdAt": "2021-01-01T00:00:00Z",
4    "id": "mapping-rule-id",
5    "name": "Assign mapping rule",
6    "type": "assign",
7    "updatedAt": "2021-01-01T00:00:00Z",
8    "confidence": 1,
9    "config": {},
10    "createdBy": "us_usr_YOUR_ID"
11  }
12}
Built with