Patch partial item data

Use JSON patch to modify an item's data.

This route uses JSON pointer syntax to specify the data to update.

PATCH https://api.jsonpad.io/lists/{listId}/items/{itemId}/data/{pointer}

On a list with write rules, this is checked against the rules for update before anything is written. A write nothing authorises is refused with 403, one that fails a check with 400 and the rule's message, and one whose item changed while it was being written with 409.

Example

123456789101112131415161718

curl https://api.jsonpad.io/lists/a401bf4f-2d11-41b6-96ab-506f9ca81467/items/3e2f7bcd-8972-4f97-803d-1f25761bae37/data/locations \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '[
        {
          "op": "remove",
          "path": "/0"
        },
        {
          "op": "add",
          "path": "/0",
          "value": {
            "city": "Chicago",
            "state": "IL"
          }
        }
      ]'

Parameters

required
listIdstringA list id or path name.
required
itemIdstringAn item id or alias.
required
pointerstringA JSON pointer to the field in the item's data that will be returned.
optional
includeDatabooleanhttps://api.jsonpad.io/lists/1f75352c-ceee-405c-8e43-ab4e56461ca5/items/180b8127-9f5e-4d16-87ff-4e119732b2bd/data/locations?includeData=true
Whether to include the item data in the response or not. Can be true or false.
Defaults to true.
optional
includeGuardedboolean?includeGuarded=true
Include values hidden by guard indexes in the response. Can be true or false.
This only applies when the request is authenticated as an identity, and only to the items that identity owns. Without an identity, guarded values stay hidden.
Defaults to false.

Request headers

required
x-api-tokenstringYour API token.
optional
if-matchstring
The item's ETag, from the etag header of the response you last read or wrote it with.
If the item has changed since then, nothing is written and we return a 412 ("Precondition failed") response. Fetch the item again and retry. See conditional writes.
optional
x-identity-tokenstringAn identity token.
optional
x-identity-groupstringAn identity group.

Request body

[0: {op: "remove"
path: "/0"
}
1: {op: "add"
path: "/0"
value: {city: "Chicago"
state: "IL"
}
}
]

required
*anyJSON patch data to be applied to the item's data at the specified pointer.

Response body

200 OK

{id: "e781f67c-65d2-4fdf-b2b9-8f4d9693ec12"
createdAt: "2026-09-23T21:08:29.239Z"
updatedAt: "2026-09-23T21:08:29.239Z"
data: {name: "John Doe"
age: 30
locations: [0: {city: "New York"
state: "NY"
}
1: {city: "Los Angeles"
state: "CA"
}
]
}
version: "1"
readonly: false
activated: true
description: "This is a sample item"
tags: [0: "my-app"
]
size: 111
locked: false
identity: {id: "e100ee4e-1b76-4723-a1b0-d7b58def40b4"
displayName: "Sample Display Name"
}
}

Response headers

etagaf2bdbe1aa9b6ec1e2ade1d694f41fc71a831d0268e9891562113d8a62add1bfA SHA-256 hash of the item.
last-modified2026-09-23T21:08:29.239ZThe date this item was last modified.

2026-09-22