Sign in
Routes
Tasks
Instructions

Update Task Instruction

This request updates a Task Instruction.

All request body properties are optional. Include only the fields you want to update.

The response field is type-dependent — see the request body schema for accepted values per instruction type.

patch/v2/tasks/instructions/{instructionID}

Request body

instructionstring

The text that guides a user on what to do on this instruction.

parentInstructionIDinteger nullable

The instructionID of this instruction's parent. A value of 0 or null removes the parent (makes this a top-level instruction).

{"stackTrail":"paths:/v2/tasks/instructions/{instructionID}:patch:requestBody:content:application/json:schema:properties:response","oasType":"schema","type":"unknown","description":"The response value for the instruction. The accepted value depends on the instruction type:\n\n| Type | Accepted value |\n|------|----------------|\n| 1 Checkbox | `true` or `false` |\n| 2 Radio List | `itemOptionID` of the selected option, or `0` to clear |\n| 3 Text Box | string |\n| 4 Dropdown | `itemOptionID` of the selected option, or `0` to clear |\n| 5 Date Picker | Unix timestamp (integer) |\n| 13 Number | number |\n\nSending `response` for any other instruction type returns a 400."}

Response

The operation completed successfully. The response body is empty.

Changes