Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.leadpipe.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Create an audience

POST /v1/intent/audiences
x-api-key: YOUR_API_KEY
Content-Type: application/json

{
  "name": "Marketing Directors at Tech Companies",
  "status": "draft",
  "config": {
    "topicIds": [117805, 117890, 117918],
    "minScore": 70,
    "maxScore": 99,
    "minTopicOverlap": 2,
    "filters": {
      "company.industries": {
        "values": ["software development"]
      },
      "role.seniority": {
        "values": ["director", "vp", "c_suite"]
      },
      "contact.hasBusinessEmail": true
    }
  }
}
name and config.topicIds are required. status can be draft, active, or paused.

​
Response

{
  "data": {
    "id": "6fb81599-f601-4afe-b3ff-e8a211cae27d",
    "organizationId": "0f1815d3-6edc-4e8e-87e1-4d65ef4f1d2c",
    "name": "Marketing Directors at Tech Companies",
    "status": "draft",
    "accessType": "paid",
    "dailyRefreshEnabled": false,
    "audienceSize": 0,
    "createdAt": "2026-05-05T09:15:00.000Z",
    "updatedAt": "2026-05-05T09:15:00.000Z"
  }
}

​
Activate or pause

PATCH /v1/intent/audiences/{id}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Activate: 
{ "status": "active" }
Pause: 
{ "status": "paused" }
Activating an audience can consume an audience slot. If all slots are in use, the API returns 403 SLOTS_FULL.

​
Update config

{
  "name": "Updated Name",
  "config": {
    "topicIds": [117805],
    "minScore": 80,
    "filters": {
      "jobTitle.include": {
        "values": ["chief financial officer", "cfo"],
        "operator": "contains",
        "mode": "any"
      }
    }
  }
}

​
List audiences

GET /v1/intent/audiences?status=active&limit=50
x-api-key: YOUR_API_KEY

{
  "data": [
    {
      "id": "6fb81599-f601-4afe-b3ff-e8a211cae27d",
      "name": "Marketing Directors at Tech Companies",
      "status": "active",
      "accessType": "paid",
      "dailyRefreshEnabled": true,
      "audienceSize": 151,
      "lastRefreshedAt": "2026-05-05T08:45:00.000Z",
      "createdAt": "2026-05-04T16:20:00.000Z"
    }
  ]
}

​
Delete an audience

DELETE /v1/intent/audiences/{id}
x-api-key: YOUR_API_KEY
Delete returns a standard delete response when the audience is removed.