PersistIQ Campaign Leads API
The Campaign Leads API from PersistIQ — 2 operation(s) for campaign leads.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/persistiq-campaign-leads-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: PersistIQ API V1 Campaign Leads API
version: v1
description: Public REST API for PersistIQ. Authenticate with your API key in the `x-api-key` header.
servers:
- url: https://api.persistiq.com
description: Production
security:
- api_key: []
tags:
- name: Campaign Leads
paths:
/v1/campaigns/{campaign_id}/leads:
get:
summary: List leads in a campaign
tags:
- Campaign Leads
parameters:
- name: campaign_id
in: path
required: true
description: Campaign hashed ID
schema:
type: string
- name: page
in: query
required: false
description: Page number for pagination
schema:
type: integer
responses:
'200':
description: campaign leads listed
content:
application/json:
schema:
type: object
properties:
has_more:
type: boolean
next_page:
type:
- string
- 'null'
status:
type: string
errors:
type: array
items:
type: string
campaign_leads:
type: array
items:
$ref: '#/components/schemas/campaign_lead_type'
post:
summary: Add a lead to a campaign
tags:
- Campaign Leads
parameters:
- name: campaign_id
in: path
required: true
description: Campaign hashed ID
schema:
type: string
responses:
'200':
description: lead added to campaign
content:
application/json:
schema:
type: object
properties:
status:
type: string
error:
type:
- object
- 'null'
campaign_lead:
$ref: '#/components/schemas/campaign_lead_type'
requestBody:
content:
application/json:
schema:
type: object
properties:
lead_id:
type: string
description: Hashed ID of the lead to add
mailbox_id:
type: string
description: Hashed ID of the mailbox to use (optional, defaults to campaign owner mailbox)
skip_if_exists:
type: boolean
description: If true, return existing campaign lead instead of error
override_lead_limit:
type: boolean
description: Override campaign lead limit
leads:
type: array
description: 'Bulk add: array of lead IDs (up to 100)'
items:
type: string
/v1/campaigns/{campaign_id}/leads/{id}:
delete:
summary: Remove a lead from a campaign
tags:
- Campaign Leads
parameters:
- name: campaign_id
in: path
required: true
description: Campaign hashed ID
schema:
type: string
- name: id
in: path
required: true
description: Lead hashed ID to remove
schema:
type: string
responses:
'200':
description: lead removed from campaign
'400':
description: lead not in campaign
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
components:
schemas:
campaign_lead_type:
type: object
properties:
id:
type: string
campaign_id:
type: string
mailbox_id:
type: string
lead:
$ref: '#/components/schemas/lead_type'
lead_type:
type: object
properties:
id:
type: string
status:
type:
- string
- 'null'
data:
type: object
additionalProperties: {}
creator_id:
type:
- string
- 'null'
owner_id:
type:
- string
- 'null'
bounced:
type: boolean
optedout:
type: boolean
sent_count:
type: integer
replied_count:
type: integer
last_sent_at:
type:
- string
- 'null'
error_response:
type: object
properties:
status:
type: string
example: error
error:
type: object
properties:
reason:
type: string
message:
type: string
securitySchemes:
api_key:
type: apiKey
name: x-api-key
in: header
description: API key found in Settings > Integrations > API Key