Skip to main content
Edit endpoints that use PATCH change only the fields in the request body. Each field can be in one of three states: Send only what you want to change. A field that you do not know about, or that a later version of the API adds, is never overwritten.

Change one field

For example, to rename an equipment and keep its code, data, parent asset, and holder:

Clear a field

Send null to remove a value. This request removes the equipment’s holder and leaves every other field as it was:
Sending null for a field that cannot be cleared, such as name, returns 400 Bad Request.
Some HTTP clients and generated SDKs omit properties whose value is null. Check that yours sends the null when you need to clear a field; otherwise the field keeps its value.

Endpoints that replace the whole resource

Some edit endpoints only have a PUT, which replaces every editable field: a field you omit can be cleared. Where a resource has both, the PUT keeps working as it does today. Before a PUT is removed, it is marked as deprecated in the API reference and keeps working for a while, so move your integration to the PATCH endpoint when one is available.