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

Instantly Campaign API

A campaign that can be sent to a list of recipients

Instantly Campaign API is one of 30 APIs that Instantly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 19 operations across 16 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.instantly.ai.

19 operations 16 paths 1 schemas 1 DELETE9 GET1 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.instantly.ai/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Instantly Campaign API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 19

Across 16 paths, the API surfaces 19 operations — 1 DELETE, 9 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Campaign 19

A campaign that can be sent to a list of recipients

POST
/api/v2/campaigns
Create campaign
createCampaign body → 200400401402404429
GET
/api/v2/campaigns
List campaign
listCampaign 7 params → 200401402404429
POST
/api/v2/campaigns/{id}/activate
Activate(start), or resume a campaign
activateCampaign 1 param → 200400401402404429
POST
/api/v2/campaigns/{id}/pause
Stop(or pause) a campaign
pauseCampaign 1 param → 200400401402404429
GET
/api/v2/campaigns/{id}
Get campaign
getCampaign 1 param → 200401402404429
PATCH
/api/v2/campaigns/{id}
Patch campaign
patchCampaign 1 param body → 200401402404429
DELETE
/api/v2/campaigns/{id}
Delete campaign
deleteCampaign 1 param body → 200401402404429
GET
/api/v2/campaigns/search-by-contact
Search campaigns by lead email
searchByContact 3 params → 200401402404429
GET
/api/v2/campaigns/analytics
Get campaign(s) analytics
getCampaignAnalytics 5 params → 200400401402404429
GET
/api/v2/campaigns/analytics/overview
Get campaign(s) analytics overview
getCampaignAnalyticsOverview 6 params → 200400401402404429
GET
/api/v2/campaigns/analytics/daily
Get daily campaign analytics
getDailyCampaignAnalytics 4 params → 200400401402404429
GET
/api/v2/campaigns/analytics/steps
Get campaign steps analytics
getCampaignStepsAnalytics 4 params → 200400401402404429
POST
/api/v2/campaigns/{id}/share
Share a campaign
shareCampaign 1 param → 204401402404429
POST
/api/v2/campaigns/{id}/from-export
Create campaign from shared one
createFromExport 1 param → 200401402403404429
POST
/api/v2/campaigns/{id}/export
Export campaign to JSON format
exportCampaign 1 param → 200401402404429
POST
/api/v2/campaigns/{id}/duplicate
Duplicate campaign
duplicate 1 param body → 200400401402404429
GET
/api/v2/campaigns/count-launched
Get launched campaigns count
countLaunched → 200401402404429
POST
/api/v2/campaigns/{id}/variables
Add campaign variables
addVariables 1 param body → 200401402404429
GET
/api/v2/campaigns/{id}/sending-status
Get campaign sending status
getCampaignSendingStatus 2 params → 200401402404429

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Campaign (38 properties). Each schema is shown below with its type and property counts.

Campaign
object
A campaign that can be sent to a list of recipients
38 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instantly-ai-campaign-api-openapi.yml Raw ↑

Other APIs Instantly publishes across the network.

Instantly Campaigns API
Instantly Account API
Instantly Account Campaign Mapping API
Instantly Analytics API
Instantly API Key API
Instantly Audit Log API
Instantly Background Job API
Instantly Block List Entry API
Instantly Campaign Subsequence API
Instantly CRM Actions API
Instantly Custom Tag API
Instantly Custom Tag Mapping API
Where this information came from

This is an independent, third-party profile of Instantly Campaign 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.