Update a mapping program

PATCH

Updates a mapping program

Path parameters

programIdstringRequired

ID of the program

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

sourceobjectRequired

Source schema

destinationobjectRequired

Destination schema

familyIdstringOptional

ID of the family to add the program to

namespacestringOptional

Namespace of the program

savebooleanOptional

Whether to save the program for editing later. Defaults to false. If true, the response will contain an ID and access token.

Response

This endpoint returns an object.

dataobject

Errors

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/mapping/:programId \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "source": {
7     "name": "string",
8     "fields": [
9       {
10         "type": "string",
11         "key": "string"
12       }
13     ]
14   },
15   "destination": {
16     "name": "string",
17     "fields": [
18       {
19         "type": "string",
20         "key": "string"
21       }
22     ]
23   }
24 }'

1 {
2   "data": {
3     "rules": [
4       {
5         "name": "string",
6         "type": "string",
7         "acceptedAt": "2023-01-01T00:00:00Z",
8         "acceptedBy": "string",
9         "confidence": 0,
10         "config": {},
11         "createdAt": "2023-01-01T00:00:00Z",
12         "createdBy": "string",
13         "deletedAt": "2023-01-01T00:00:00Z",
14         "id": "string",
15         "metadata": {},
16         "updatedAt": "2023-01-01T00:00:00Z"
17       }
18     ],
19     "sourceKeys": [
20       "string"
21     ],
22     "destinationKeys": [
23       "string"
24     ],
25     "id": "string",
26     "namespace": "string",
27     "familyId": "string",
28     "createdAt": "2023-01-01T00:00:00Z",
29     "createdBy": "string",
30     "summary": {
31       "totalRuleCount": 0,
32       "addedRuleCount": 0,
33       "deletedRuleCount": 0
34     },
35     "accessToken": "string"
36   }
37 }

Built with

1	curl -X PATCH https://api.x.flatfile.com/v1/mapping/:programId \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"source": {
7	"name": "string",
8	"fields": [
9	{
10	"type": "string",
11	"key": "string"
12	}
13	]
14	},
15	"destination": {
16	"name": "string",
17	"fields": [
18	{
19	"type": "string",
20	"key": "string"
21	}
22	]
23	}
24	}'

1	{
2	"data": {
3	"rules": [
4	{
5	"name": "string",
6	"type": "string",
7	"acceptedAt": "2023-01-01T00:00:00Z",
8	"acceptedBy": "string",
9	"confidence": 0,
10	"config": {},
11	"createdAt": "2023-01-01T00:00:00Z",
12	"createdBy": "string",
13	"deletedAt": "2023-01-01T00:00:00Z",
14	"id": "string",
15	"metadata": {},
16	"updatedAt": "2023-01-01T00:00:00Z"
17	}
18	],
19	"sourceKeys": [
20	"string"
21	],
22	"destinationKeys": [
23	"string"
24	],
25	"id": "string",
26	"namespace": "string",
27	"familyId": "string",
28	"createdAt": "2023-01-01T00:00:00Z",
29	"createdBy": "string",
30	"summary": {
31	"totalRuleCount": 0,
32	"addedRuleCount": 0,
33	"deletedRuleCount": 0
34	},
35	"accessToken": "string"
36	}
37	}