Partial Updates

Some Wristband APIs let you update specific fields without needing to include the entire entity in the request body.

For any APIs that do support partial updates, they follow the Json Merge Patch Specification. With partial updates, you only need to pass the fields you want to update. Any fields left out will retain their original values. This simplifies updates, ensuring existing fields aren't unintentionally deleted.

For example, to update a user's middle name using the Patch User API, your request body would look like:

Example Request Body

{
  "middleName": "Jerry"
}

To delete (nullify) a value, explicitly pass a null value for the field:

Example Request Body With Nullified Field

{
  "middleName": null
}