Skip to main content
PATCH
/
api
/
lists
/
{id}
Update a list
curl --request PATCH \
  --url https://app.puffle.ai/api/lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "sheet": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "enrichmentStatus": "idle",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "activeSearchId": "<string>",
    "searchFilters": {}
  }
}

​
Overview

Partial update of list-level fields. Only name is writable through this endpoint; enrichment state is managed by background tasks.
This operation shares the URL path /api/lists/{id} with other verbs. See the sibling page for related operations on the same resource.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

List UUID.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Only the name field is supported today. Other fields on the list (enrichment status, active search ID, search filters) are owned by background tasks and can't be set by the user directly.

​
name
string

New display name. Only non-empty fields are applied.

Response

List updated. Returns the full list summary.

​
sheet
object
required

Canonical List entity in camelCase. Returned by every list endpoint under a sheet key (historical — rows and columns together formed a spreadsheet-like sheet).