Update item

UpdateItem changes an Item's label, quantity or due date. An unset field is left alone.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

itemUid?string

label?string

Each field is optional: an unset one is left alone, so changing a quantity does not have to restate the label.

quantity?string

dueOn?string

note?string

The Note, as markdown. Sending an empty string removes it.

expectedLabel?string

What the caller believed the text was when they started changing it.

Set one of these and the change is refused when the stored text is something else, with ABORTED. That is the whole of conflict detection in Nooks, and it is only offered for text: a tick says what an Item should be rather than what it was, so there is nothing to compare and nothing to refuse.

Leave them unset and the write is unconditional, which is what a script wants.

expectedNote?string

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/items/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "item": {    "uid": "string",    "label": "string",    "quantity": "string",    "dueOn": "string",    "done": true,    "addedByName": "string",    "doneByName": "string",    "doneAt": "string",    "doneByUid": "string",    "note": "string",    "addedViaToken": "string"  }}

Update item

Path Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`