No results

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}

Example

cURL
123456789101112131415161718curl https://api.jsonpad.io/lists/d74f3dd1-7a80-4334-84dc-1cc29984c0e7/items/89f0d927-b7f7-4630-af8a-7592ea806416/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/4b108a1c-fac1-4748-bdab-aa4232753d5c/items/03ef4adb-04b8-4592-818e-0c26a4dcd42d/data/locations?includeData=true

    Whether to include the item data in the response or not. Can be true or false.

    Defaults to true.

Request headers

  • required
    x-api-tokenstringYour API token.
  • 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: "fd626012-c823-4e19-8aa4-7ae24a993266"
createdAt: "2026-09-05T11:30:12.243Z"
updatedAt: "2026-09-05T11:30:12.243Z"
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"
size: 111
locked: false
}

Response headers

  • etagaf2bdbe1aa9b6ec1e2ade1d694f41fc71a831d0268e9891562113d8a62add1bfA SHA-256 hash of the item.
  • last-modified2026-09-05T11:30:12.243ZThe date this item was last modified.
2024-10-29