Update a checklist item

patch

https://sandbox.uk.rootplatform.com/v1/insurance/tasks/{task_id}/checklist/{item_id}

Path Params

task_id

uuid

required

The unique identifier of the task.

item_id

uuid

required

The unique identifier of the checklist item.

Body Params

label

string

The label describing the checklist item.

item_type

string

enum

The type of the checklist item's value. Locked once the item has a captured answer — a recorded answer, a stored value, or is_done — because reinterpreting captured data as another type would change what it means. Re-submitting the item's current type is always allowed.

Allowed:

is_done

boolean

Whether the checklist item has been completed. Completion affecting, so it is rejected with 409 on a finished task.

required

boolean

Whether the checklist item must be resolved before the task can be completed. Only the task's creator or a manager may change this.

sort_order

integer

≥ 0

The position of the checklist item within the task's checklist.

value

string | number | null

null is allowed. The value of the checklist item. date values are YYYY-MM-DD; currency values are a non-negative integer amount in cents.

Responses

409

The task is complete or cancelled, so the checklist item is frozen against edits that would change whether the task should still be complete: the answer, the value, the done flag and the required flag. Reopen a completed task first; a cancelled task cannot be reopened. A rename, a reorder or a type change does not affect completeness and is still accepted.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success