Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
task-config

Update an existing task config

patch/v1/org/{orgId}/task-config/{id}

Path parameters

orgIdstring required

Org identifier (either id or slug

idstring required

ID of the desired task config

Request body

type'FORM_SUBMIT' | 'FORM_RESPONSE_APPROVE' | 'FORM_RESPONSE_RESUBMIT' | 'CHANGE_APPROVE' | 'TIMEOFF_APPROVE' | 'SCENARIO_CHANGES_APPROVE' | 'SCENARIO_CHANGES_CREATE' | 'ORG_IMPORT' | 'COMP_REVIEW_APPROVAL_SUBMIT' | 'SCENARIO_APPROVAL_SUBMIT' | 'APPROVAL_CHAIN_UPDATE_FALLBACK_APPROVER' | 'ACTION' | 'SIGNATURE' | 'GOAL_PROGRESS' | 'TODO'

type of task generated by the task config

pastDueAction'NONE' | 'SET_EXPIRED'

sets pastDueAction on the task when it's generated

isSkippableboolean

sets isSkippable on the task

labelstring

human-readable label that should be used for all tasks associated with the config as the task name

descriptionstring

description for all tasks associated with the config that should be used in notifications

deleteIdstring

deleted by user id

deleteAtstring

deleted timestamp

Example request

{
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteAt": "2017-01-24T13:57:52Z"
}

Response

successful operation