Create a routine

POST

1 curl -X POST https://api.x.flatfile.com/v1/routines \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "runbookId": "us_rb_YOUR_ID",
7   "name": "Split Address to Street, City, State, Zip",
8   "config": {
9     "sourceSheetId": "us_sh_YOUR_ID",
10     "destinationSheetId": "us_sh_YOUR_ID",
11     "programId": "us_mp_YOUR_ID"
12   },
13   "ordinal": 1,
14   "type": "JOB"
15 }'

Play

200Example0

1 {
2   "data": {
3     "id": "us_rtn_YOUR_ID",
4     "runbookId": "us_rb_YOUR_ID",
5     "name": "Split Address to Street, City, State, Zip",
6     "config": {
7       "sourceSheetId": "us_sh_YOUR_ID",
8       "destinationSheetId": "us_sh_YOUR_ID",
9       "programId": "us_mp_YOUR_ID"
10     },
11     "ordinal": 1,
12     "type": "JOB",
13     "createdBy": "us_usr_YOUR_ID",
14     "createdAt": "2024-12-05T00:00:00Z",
15     "updatedAt": "2024-12-05T00:00:00Z"
16   }
17 }

Creates a new routine

Request

This endpoint expects an object.

runbookIdstringRequired

Runbook ID

namestringRequired

The name of the Routine.

configanyRequired

Configuration for the Routine. Related to the type of Routine.

ordinalintegerRequired

The order of the Routine in the Runbook.

typeenumRequired

The type of Routine.

Allowed values:

Response

This endpoint returns an object.

dataobject

Routine is a set of instructions or procedures that are followed to complete a task.

Create a routine

Headers

Request

Response

Errors