v1

latestOpenAPI 3.0.0MIT2026-07-14182629.1 KB
List

Update List

Update the name of a list with the given list ID.<br><br>Rate limit:<br>Limit: 150<br>TTL: 60s

Scopes: list:manage

patch/api/list/{listId}

Path parameters

listIdstring required

Primary key that uniquely identifies this list. Generated by Bespoke.

Example:UUID

Primary key that uniquely identifies this list. Generated by Bespoke.

Headers

revisionstring required

API endpoint revision (format: YYYY-MM-DD[.suffix])

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "Newsletter"
    }
  }
}

Response

Update A List

isDefaultStoreListboolean required
namestring required
starredboolean required
createdAtstring date-time required
updatedAtstring date-time required