Instantly.ai API Documentation
This is the complete API documentation for connecting to the Instantly.ai API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Instantly.ai: connect business data and workflows through MindCloud's Universal API. Keep reading to get started.
Quickstart
Before you run your first Instantly.ai request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Instantly.ai connection — create or choose one in Connections. Note its
connectionId.
Every Instantly.ai action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/instantlyai/actions/{actionSlug}/runYou need a MindCloud API Key and a Instantly.ai connection. Then call an action such as Get Campaigns:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/instantlyai/actions/get-campaigns/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Instantly.ai account. See Instantly.ai API Authentication for the full flow and how to get your connection credentials.
Instantly.ai actions
All 24 published actions for this Instantly.ai version. Each page documents the endpoint, arguments, and response controls.
- GETAdd Custom Tracking Domain
- POSTAdd Leads to Campaign
- GETAssign Tag to Account
- GETAssign Tag to Campaign
- POSTCreate a Campaign
- GETCreate New Tag
- GETDelete a Tag
- GETGet a Tag by ID
- GETGet Campaign Accounts
- GETGet Campaign Name
- GETGet Campaign Status
- GETGet Campaigns
- GETGet Result of Verified Email
- GETGet Sending Accounts
- GETGet Status of Tracking Domain
- GETGet Tags
- GETLead Attributes | Delete
- GETLead Attributes | Set
- GETLead Attributes | Update
- GETRemove Tracking Domain
- PUTSet Campaign Name
- GETUpdate a Tag
- GETUpdate Lead Status
- PUTVerify Email
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.