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: Manage outreach campaigns, leads, accounts, and workspace settings. Keep reading to get started.

Quickstart

Before you run your first Instantly.ai request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Instantly.ai connection — create or choose one in Connections. Note its connectionId.

Every Instantly.ai action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/instantly/latest/actions/{actionSlug}

You need a MindCloud API Key and a Instantly.ai connection. Then call an action such as Get Account:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/instantly/latest/actions/get-account" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Instantly.ai account that should run the action. MindCloud stores and refreshes the Instantly.ai credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Instantly.ai actions

All 48 published actions for this Instantly.ai version. Each page documents the endpoint, arguments, and response controls.

• PUTActivate Campaign
• POSTAdd Leads To Campaign Or List
• PUTBulk Assign Leads
• POSTCreate Account
• POSTCreate Campaign
• POSTCreate Lead
• POSTCreate Lead List
• POSTCreate Webhook
• DELETEDelete Email
• DELETEDelete Lead
• DELETEDelete Webhook
• POSTForward Email
• GETGet Account
• GETGet Campaign
• GETGet Campaign Analytics Overview
• GETGet Current Workspace
• GETGet Daily Account Analytics
• GETGet Daily Campaign Analytics
• GETGet Email
• GETGet Lead
• GETGet Lead List
• GETGet Lead List Verification Stats
• GETGet Unread Email Count
• GETGet Webhook
• GETList Accounts
• GETList Campaigns
• GETList Emails
• GETList Lead Lists
• GETList Leads
• GETList Webhooks
• PUTMark Email Thread As Read
• PUTMerge Leads
• PUTMove Leads
• PUTPause Account
• PUTPause Campaign
• POSTReply To Email
• PUTResume Account
• PUTResume Webhook
• GETSearch Campaigns By Contact
• POSTSend Test Email
• GETTest Account Vitals
• PUTUpdate Account
• PUTUpdate Campaign
• PUTUpdate Email
• PUTUpdate Lead
• PUTUpdate Lead Interest Status
• PUTUpdate Lead List
• PUTUpdate Webhook

Related apps

More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite