POST
/
v1
/
lists
curl -X POST https://api.pipeium.com/v1/lists \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tech Startups Q1 2024",
    "data": [
      {
        "name": "John Smith",
        "company": "Acme Inc",
        "domain": "acme.com",
        "linkedin": "https://linkedin.com/in/johnsmith",
        "title": "CEO"
      }
    ],
    "mappings": {
      "first_name": "name",
      "website": "domain",
      "company_name": "company",
      "linkedin_url": "linkedin",
      "job_title": "title"
    },
    "webhook_url": "https://your-domain.com/webhook"
  }'

{
  "message": "List created",
  "listId": "list_123"
}

​
Request Body

​
name
string
required

Name of the list

​
data
array
required

Array of prospect data objects. Maximum 200 prospects per list.

​
mappings
object
required

Field mappings to standardize input data:

{
  first_name: string;      // required
  last_name?: string;      // optional
  website: string;         // required
  company_name?: string;   // optional
  linkedin_url?: string;   // optional
  job_title?: string;      // optional
}
​
webhook_url
string

Optional webhook URL to receive notifications when list processing is complete

​
Response

​
message
string

Success message confirming the list was created

​
listId
string

The ID of the created list

curl -X POST https://api.pipeium.com/v1/lists \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tech Startups Q1 2024",
    "data": [
      {
        "name": "John Smith",
        "company": "Acme Inc",
        "domain": "acme.com",
        "linkedin": "https://linkedin.com/in/johnsmith",
        "title": "CEO"
      }
    ],
    "mappings": {
      "first_name": "name",
      "website": "domain",
      "company_name": "company",
      "linkedin_url": "linkedin",
      "job_title": "title"
    },
    "webhook_url": "https://your-domain.com/webhook"
  }'

{
  "message": "List created",
  "listId": "list_123"
}