No results

Update an item

Update an item.

If the request body contains data, the item's current data will be replaced.

PUT https://api.jsonpad.io/lists/{listId}/items/{itemId}

Example

cURL
1234567891011curl https://api.jsonpad.io/lists/821126ec-8c32-4e94-89f5-336433852cb3/items/0a794923-d3c0-42c6-b4f1-3892f6871ed0 \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "data": {
          "name": "Jane Doe"
        },
        "description": "This is an updated item",
        "version": "2"
      }'

Parameters

  • required
    listIdstringA list id or path name.
  • required
    itemIdstringAn item id or alias.
  • optional
    includeDatabooleanhttps://api.jsonpad.io/lists/0b7d51e0-0cbd-4c17-85d8-b1eb869eba4a/items/e11d0de7-93e9-445b-9515-c3be255f318c?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

{
data: {
name: "Jane Doe"
}
description: "This is an updated item"
version: "2"
readonly: false
activated: true
}
  • required
    dataanyThe item's new data.
  • optional
    descriptionstringA description of the item.
  • optional
    versionstring

    The item's current version.

    By default this will start out as "1" and increment naturally (e.g. "2", "3", and so on), however you can set this to practically any version number format and it will be incremented accordingly.

    Examples
    • "" (empty string) will be incremented to "1".
    • 1 will be incremented to 2.
    • 0.12 will be incremented to 0.13.
    • 0.1.0 will be incremented to 0.1.1.
    • 0.1.0b will be incremented to 0.1.1b.
    • 4test123 will be incremented to 4test124.
  • optional
    readonlybooleanWhether the item is read-only.
  • optional
    activatedbooleanWhether the item is activated. Inactive items are not accessible or usable via the API.

Response body

200 OK
{
id: "42c2b73f-8a4e-4838-b89b-dd72368f5765"
createdAt: "2026-09-05T11:30:04.488Z"
updatedAt: "2026-09-05T11:30:04.488Z"
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:04.488ZThe date this item was last modified.
2024-10-29