Update a routine

curl -X PATCH https://api.x.flatfile.com/v1/routines/us_rtn_YOUR_ID \
     -H "X-Disable-Hooks: true" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Split Address to Street, City, State, Zip",
  "config": {
    "sourceSheetId": "us_sh_YOUR_ID",
    "destinationSheetId": "us_sh_YOUR_ID",
    "programId": "us_mp_YOUR_ID"
  },
  "ordinal": 1,
  "type": "JOB"
}'

{
  "data": {
    "id": "us_rtn_YOUR_ID",
    "runbookId": "us_rb_YOUR_ID",
    "name": "Split Address to Street, City, State, Zip",
    "config": {
      "sourceSheetId": "us_sh_YOUR_ID",
      "destinationSheetId": "us_sh_YOUR_ID",
      "programId": "us_mp_YOUR_ID"
    },
    "ordinal": 1,
    "type": "JOB",
    "createdBy": "us_usr_YOUR_ID",
    "createdAt": "2024-12-05T00:00:00Z",
    "updatedAt": "2024-12-05T00:00:00Z"
  }
}

Updates a routine

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

routineIdstringRequired

Routine ID

Request

This endpoint expects an object.

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.

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors