Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Instantly Campaigns API

The Campaigns API from Instantly — 10 operation(s) for campaigns.

Instantly Campaigns API is published by Instantly 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 API documentation.

This API exposes 13 operations across 10 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.

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

13 operations 10 paths 1 schemas 1 DELETE5 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 13

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

Campaigns 13
GET
/api/v2/campaigns
List campaigns
listCampaigns → 200
POST
/api/v2/campaigns
Create a campaign
createCampaign body → 201
GET
/api/v2/campaigns/{id}
Get a campaign
getCampaign 1 param → 200
PATCH
/api/v2/campaigns/{id}
Update a campaign
updateCampaign 1 param body → 200
DELETE
/api/v2/campaigns/{id}
Delete a campaign
deleteCampaign 1 param → 204
POST
/api/v2/campaigns/{id}/activate
Activate campaign
activateCampaign 1 param → 200
POST
/api/v2/campaigns/{id}/pause
Pause campaign
pauseCampaign 1 param → 200
GET
/api/v2/campaigns/search-by-contact
Search campaigns by contact
searchCampaignsByContact 1 param → 200
POST
/api/v2/campaigns/{id}/share
Share campaign
shareCampaign 1 param → 200
POST
/api/v2/campaigns/{id}/duplicate
Duplicate campaign
duplicateCampaign 1 param → 201
POST
/api/v2/campaigns/{id}/export
Export campaign
exportCampaign 1 param → 200
GET
/api/v2/campaigns/count-launched
Count launched campaigns
countLaunchedCampaigns → 200
GET
/api/v2/campaigns/{id}/sending-status
Get campaign sending status
getSendingStatus 1 param → 200

Schemas 1

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

Campaign
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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