Skip to main content
POST
/
api
/
lists
Create List
curl --request POST \
  --url https://app.puffle.ai/api/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "leadIds": [
    "<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 create
puffle list create --name <name> --description <description> --lead-type <lead-type> --lead-ids <lead-ids>

​
Overview

Creates a user List. Pass leadIds to attach existing canonical Leads immediately; Lead records are not copied. Common next steps are POST /api/lists/{id}/leads to attach existing Leads, POST /api/lists/import to import normalized Lead objects, or POST /api/leads/search with listId to bind a search task to the List.
This operation shares the URL path /api/lists with get, update, and delete. Use the id returned in list.id for follow-up calls.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string

Display name. Defaults to "Untitled List" when omitted.

​
description
string | null
​
leadType
enum<string>

Lead type the list is meant to contain. Defaults to person.

Available options:
person,
company,
mixed
​
leadIds
string[]

Optional initial Leads to add to the List.

Minimum string length: 1

Response

List created. Returns the List with computed leadCount.

​
list
object
required

The freshly created List.