Create a runbook

POST

1 curl -X POST https://api.x.flatfile.com/v1/runbooks \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "accountId": "us_acc_YOUR_ID",
7   "appId": "us_app_YOUR_ID",
8   "environmentId": "us_env_YOUR_ID",
9   "spaceId": "us_sp_YOUR_ID",
10   "name": "Runbook For Vendor X",
11   "config": {
12     "sourceSheetIds": [
13       "us_sh_YOUR_ID"
14     ],
15     "destinationSheetIds": [
16       "us_sh_YOUR_ID"
17     ]
18   },
19   "status": "CREATED",
20   "type": "PREPROCESSING"
21 }'

Play

200Example0

1 {
2   "data": {
3     "id": "us_rb_YOUR_ID",
4     "accountId": "us_acc_YOUR_ID",
5     "appId": "us_app_YOUR_ID",
6     "environmentId": "us_env_YOUR_ID",
7     "spaceId": "us_sp_YOUR_ID",
8     "name": "Runbook Name",
9     "config": {
10       "sourceSheetIds": [
11         "us_sh_YOUR_ID"
12       ],
13       "destinationSheetIds": [
14         "us_sh_YOUR_ID"
15       ]
16     },
17     "status": "CREATED",
18     "type": "PREPROCESSING",
19     "createdBy": "us_usr_YOUR_ID",
20     "createdAt": "2024-12-05T18:00:00Z",
21     "updatedAt": "2024-12-05T18:00:00Z"
22   }
23 }

Creates a new runbook

Request

This endpoint expects an object.

accountIdstringRequired

Account ID

appIdstringRequired

App ID

environmentIdstringRequired

Environment ID

spaceIdstringRequired

Space ID

namestringRequired

The name of the Runbook.

configobjectRequired

The configuration of the Runbook.

statusenumRequired

The status of the Runbook.

typeenumRequired

The type of the Runbook.

Allowed values:

Response

This endpoint returns an object.

dataobject

Runbook

Create a runbook

Headers

Request

Response

Errors