JSON Patch (RFC 6902)

In more detail

JSON Patch is a format for describing changes to a JSON document, defined in RFC 6902. A patch is an array of operations, applied in order. If any operation fails, the whole patch fails.

Each operation has an op and a path, which is a JSON Pointer. The six ops are add, remove, replace, move, copy and test. move and copy also take a from pointer, and add, replace and test take a value. test checks that a value is what you expect, which guards against applying a patch to a document that changed.

APIs accept JSON Patch with the HTTP PATCH method and the media type application/json-patch+json. Unlike JSON Merge Patch, it can change single array elements and set a value to null, at the cost of being more verbose.

Example

[
  { "op": "test", "path": "/version", "value": 3 },
  { "op": "replace", "path": "/name", "value": "Ada King" },
  { "op": "add", "path": "/roles/-", "value": "owner" },
  { "op": "remove", "path": "/legacyId" }
]

Try it