Skip to main content
PATCH
/
api
/
lists
Update List
curl --request PATCH \
  --url https://app.puffle.ai/api/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'
{
  "list": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "leadCount": 4503599627370495,
    "personCount": 4503599627370495,
    "companyCount": 4503599627370495,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "activeSearchTaskId": "<string>",
    "searchFilters": {}
  }
}
CLI: 
puffle list update --id <id>
puffle list update --id <id> --name <name> --description <description> --lead-type <lead-type>

​
Overview

Updates List metadata. Pass id in the JSON body with any of name, description, or leadType. The protected default all List cannot be renamed or converted, and changing leadType is rejected when existing Leads in the List would violate the requested type.
Use PATCH /api/lists with id in the JSON body. The previous path PATCH /api/lists/{id} has been removed.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
id
string
required

List UUID to update.

Minimum string length: 1
​
name
string
​
description
string | null
​
leadType
enum<string>

person lists contain person Leads, company lists contain company Leads, and mixed lists can contain both.

Available options:
person,
company,
mixed

Response

List updated.

​
list
object
required

The updated List.