Routes
Tasks
Instructions
Update Task Instruction
Changed onThis request updates a Task Instruction.
All request body properties are optional. Include only the fields you want to update.
| Parameter | Type | Required | Description |
|---|---|---|---|
| instruction | String | Optional | The text that guides a User on what to do on this Instruction. |
| parentInstructionID | Int or null | Optional | The instructionID of this Instruction's parent. A value of 0 or null removes the parent, making this a top-level Instruction. |
| response | Depends on the Instruction type | Optional | The value the User submitted for this Instruction. This is not an object. See the request body schema and examples for the accepted value per Instruction type. |
The response field is type-dependent. It is not an object. Example successful bodies: { "response": true } (checkbox), { "response": 12345 } (radio/dropdown itemOptionID), { "response": "Oil level at 75%" } (text), { "response": 1719878400 } (date), { "response": 42.5 } (number). See the request body schema and examples for accepted values per instruction type.
patch/v2/tasks/instructions/{instructionID}
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
The operation completed successfully. The response body is empty.
Changes
- breaking
the
request property type changed from no type tobooleanintegerstringnumbernull - info
the request property
became nullable
- breaking
- info
added optional request body
- info