Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Item

Update item

This endpoint can be used to update properties on the Item.

put/items/{item_id}

Path parameters

item_idstring required

Request body

metadataobject nullable

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

namestring nullable

Response

OK

metadataobject required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

idstring required

The Orb-assigned unique identifier for the item.

namestring required

The name of the item.

created_atstring date-time required

The time at which the item was created.

archived_atstring date-time nullable

The time at which the item was archived. If null, the item is not archived.