API v1

Changed Getting started Breaking

Every PUT keeps what is left out and clears what is sent as null

Every update endpoint now follows one rule. A field left out of the body keeps its stored value, and a field sent as null is cleared. A field that cannot be empty, such as a name, a label or a cadence, refuses null with 422. A boolean left out keeps its value. A list sent whole (tags, options, columns, the ways a name is written, the groups and fields of a life event type) keeps the stored list when left out and replaces it when sent. Before, these endpoints either required every field or cleared the ones left out. A relationship type left without role_b now keeps its own role_b rather than copying role_a. A notification channel destination and a notification preference timezone sent as null still keep what is saved.

Why this is a breaking change

An integration that cleared a field by leaving it out now keeps the old value. Send the field as null to clear it.

Why it changed

Each endpoint had its own idea of what a missing field meant, so changing one thing meant reading the record first and sending all of it back. Now a request carries only the change.

Changes

Field Change Endpoints
A field left out keeps its stored value Changed
PUT /me
PUT /vaults/{vault}/groups/{group}/notes/{note}
PUT /vaults/{vault}/groups/{group}/reminders/{reminder}
Send null to clear a field Changed
PUT /me
PUT /vaults/{vault}/groups/{group}/notes/{note}
PUT /vaults/{vault}/groups/{group}/reminders/{reminder}
role_b left out keeps its role rather than copying role_a Changed

In the same release