No results

Update a list

Update a list.

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

Example

cURL
1234567curl https://api.jsonpad.io/lists/bf210cef-7884-4de3-872b-cdfe2b951378 \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "name": "My Updated List"
      }'

Parameters

  • required
    listIdstringA list id or path name.

Request headers

  • required
    x-api-tokenstringYour API token.

Request body

{
name: "Sample List"
pathName: "sample-list"
description: "Sample list description"
schema: null
pinned: false
readonly: false
realtime: false
protected: false
indexable: true
activated: true
}
  • optional
    namestringThe name of the list.
  • optional
    pathNamestring

    The path name of new list. This can be used instead of the id in URLs.

    This must be unique. You cannot have two lists with the same path name.

  • optional
    descriptionstringA description of the list.
  • optional
    schemanullable object

    The schema of the list. When items are created or modified in this list, we will check their data against this schema.

    This uses the JSON Schema format. It will be null if the list has no schema.

  • optional
    pinnedbooleanWhether the list is pinned to the dashboard menu for quick access.
  • optional
    readonlybooleanWhether the list is read-only. This affects the list and all items contained within it.
  • optional
    realtimebooleanWhether realtime updates are enabled for this list. If this is enabled, the list will emit events when it is modified or deleted, and when items are created, updated or deleted within it.
  • optional
    protectedbooleanWhether the list is protected. Protected lists cannot be deleted if they contain any items.
  • optional
    indexablebooleanWhether the list is indexable. We cannot view a list of items in a non-indexable list. Also, non-indexable lists cannot be searched.
  • optional
    activatedbooleanWhether the list is activated. Inactive lists are not accessible via the API.

Response body

200 OK
{
id: "baf3023f-7215-4aed-81eb-ae255ff12de2"
createdAt: "2026-09-05T11:29:47.515Z"
updatedAt: "2026-09-05T11:29:47.515Z"
user: {
id: "ac16ecfc-c720-4888-bb78-15c80351e07f"
createdAt: "2026-09-05T11:29:47.515Z"
updatedAt: "2026-09-05T11:29:47.515Z"
lastActiveAt: "2026-09-05T11:29:47.515Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample List"
pathName: "sample-list"
description: "Sample list description"
schema: null
pinned: false
readonly: false
realtime: false
protected: false
indexable: true
activated: true
itemCount: 0
}

Response headers

  • last-modified2026-09-05T11:29:47.515ZThe date this list was last modified.
2024-10-29