How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PersistIQ Campaigns API

Outreach campaigns

PersistIQ Campaigns API is one of 12 APIs that PersistIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.persistiq.com.

5 operations 4 paths 7 schemas 1 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.persistiq.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

PersistIQ Campaigns API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). An API key is passed in the header as x-api-key (ApiKeyAuth).

  • api_key — API key found in Settings Integrations API Key
  • ApiKeyAuth — Company-wide API key. Grants access to read and write all users' data within the company. Include it in the header of every request.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Campaigns 5
GET
/v1/campaigns
List campaigns
4 params → 200
POST
/v1/campaigns
Create a campaign
body → 200422
POST
/v1/campaigns/duplicate
Duplicate a campaign
body → 200422
POST
/v1/campaigns/{campaign_id}/leads
Add leads to a campaign
addLeadsToCampaign 1 param body → 200400401429500
DELETE
/v1/campaigns/{campaign_id}/leads/{lead_id}
Remove a lead from a campaign
removeLeadFromCampaign 2 params → 200401404429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are LeadData (14 properties), User (6 properties), Campaign (4 properties), Lead (4 properties). Each schema is shown below with its type and property counts.

campaign_type
object
4 properties
LeadData
object
14 properties 1 required
CampaignLead
object
4 properties
User
object
6 properties
Lead
object
4 properties
Error
object
2 properties
Campaign
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

persistiq-campaigns-api-openapi.yml Raw ↑

Other APIs PersistIQ publishes across the network.

PersistIQ Do Not Contact Domains API
PersistIQ Events API
PersistIQ Lead Fields API
PersistIQ Lead Statuses API
PersistIQ Leads API
PersistIQ Users API
PersistIQ Campaign Leads API
PersistIQ DNC Domains API
PersistIQ Replies API
PersistIQ Tags API
PersistIQ Webhook Plugin API
Where this information came from

This is an independent, third-party profile of PersistIQ Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.