Abstract Optional apiIgnored in update calls.
Optional entityThe entity type to be fetched. e.g. 'item'
If reference is passed, the entity name of the reference will be used.
Optional idThe id of the entity to be fetched.
If referenceis passed, the id of the reference will be used.
The object to be updated. Object can be partial, only the fields that are specified will be updated.
Optional referenceA reference to the entity to be fetched. e.g. item:123.
If reference is passed, it overrides entityName and id.
Optional relationOptional relationOptional skipReturns only the updated entity, without hydrated object and type references
As of 2025-07-18, only supported by Items. Other entities will ignore this and return the full hydrated object.
Optional suffixUsed to specify a suffix to the resource path.
Generated using TypeDoc
The contract used to specify the options for PUT calls for Entities.