Update a runbook

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/runbooks/us_rb_YOUR_ID \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "name": "Runbook For Vendor X"
7 }'

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 }

Updates a runbook

Path parameters

runbookIdstringRequired

Runbook ID

Request

This endpoint expects an object.

namestringOptional

The name of the Runbook.

statusenumOptional

The status of the Runbook.

configobjectOptional

The configuration of the Runbook.

Response

This endpoint returns an object.

dataobject

Runbook

Update a runbook

Path parameters

Headers

Request

Response

Errors