canonical: https://jentic.com/apis/instantly.ai/instantly # Instantly API Jentic publishes the only available OpenAPI specification for Instantly API, keeping it validated and agent-ready. The Instantly v2 API gives outbound sales and growth teams programmatic control over cold-email infrastructure, including sender accounts, campaigns, leads, and email sends. Across 26 endpoints, the API covers account warm-up pause and resume, campaign creation, lead import, and reply tracking, so an automation can keep multi-account outbound running without UI clicks. Authentication is a single API key passed in the Authorization header, which makes embedding the API into existing workflows straightforward. ## For AI agents Manage Instantly cold-email accounts, campaigns, and leads - pause and resume sender accounts, run campaigns, and import leads programmatically. ## Scope Does not handle SMS, transactional email, or CRM contact records - use for cold-email account, campaign, and lead management only. ## Capabilities - Provision and configure Instantly sender accounts via POST /accounts and PATCH `/accounts/{id}` - Pause and resume warm-up or sending on individual accounts via `/accounts/{id}/pause` and `/accounts/{id}/resume` - Create outbound campaigns and update their step sequences via /campaigns - Import and update leads attached to campaigns through the /leads endpoints - Read sent and received emails to drive reply-handling automations through /emails - Remove or archive accounts that have been deprecated for sending ## Use cases ### Account Health Auto-Pause Listen to deliverability signals from an external monitor and call POST `/accounts/{id}/pause` when bounce or spam-complaint thresholds are exceeded, then POST `/accounts/{id}/resume` once the account recovers. This prevents domain reputation damage without requiring an operator to log into the Instantly dashboard, and the small endpoint surface makes the integration achievable in a few hours. Example prompt: When monitor flags an account, POST `/accounts/{id}/pause`; when health recovers, POST `/accounts/{id}/resume.` ### Lead Import from CRM to Campaign When a CRM tags a contact as 'outbound-ready', push the contact into the matching Instantly campaign via the /leads endpoints with full custom variables for personalisation. The integration removes the manual CSV upload step and keeps the campaign seeded with fresh leads as soon as they qualify in the CRM. Example prompt: For each CRM contact tagged 'outbound-ready', call the Instantly create-lead operation with the campaign id, email, and merge fields. ### Reply Routing into a Helpdesk Poll /emails for inbound replies to outbound campaigns, classify intent, and forward qualified replies into a sales inbox or helpdesk. This avoids the trap of replies sitting unread in a sender mailbox by routing them to the system where reps actually work. Example prompt: List Instantly emails received in the last hour, filter to replies, and create a corresponding helpdesk ticket for each one. ### AI Agent Outbound Operator via Jentic An AI agent given access to Instantly through Jentic can spin up a campaign, attach leads, and respond to deliverability alerts on its own. Jentic exposes each Instantly v2 operation by intent and isolates the API key in its vault, so the agent makes structured calls without seeing the credential. Example prompt: Through Jentic, call instantly_create_campaign with a name and step sequence, then instantly_add_leads to attach a list of prospects to the new campaign. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/accounts` | Create a sender account | | GET | `/accounts` | List sender accounts | | POST | `/accounts/{id}/pause` | Pause an account | | POST | `/accounts/{id}/resume` | Resume an account | | POST | `/campaigns` | Create an outbound campaign | ## Key resources - **Accounts** — Manage sender mailboxes, including pause and resume controls. - **Campaigns** — Create and update outbound campaigns and their step sequences. - **Leads** — Import, update, and remove leads attached to campaigns. - **Emails** — Read sent and received emails for reply handling. ## Why Jentic - **Setup:** Wiring the Instantly v2 API by hand means setting up its header API key auth, tracking the `/api/v2` base path, and handling account pause and resume flows yourself. Through Jentic you install once, import the Instantly API from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** Instantly puts the account id in the URL path (`/accounts/{id}/pause`, `/accounts/{id}/resume`), so a rule can pin your agent to one account and the campaign and lead operations you approve. You choose the operations it may call, so account creation is not included unless you add it. - **Credential handling:** Your Instantly API key is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'pause an Instantly account' or 'create an Instantly campaign', and Jentic returns the matching v2 operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Salesloft API** — Salesloft is an enterprise sales engagement platform with cadences and dialer support. - **Outreach API** — Outreach offers comparable cold-email sequences with deeper analytics and team controls. - **Apollo API** — Apollo provides B2B contact data that feeds into Instantly campaigns as leads. ## FAQ ### Why is there no official OpenAPI spec for Instantly API? Instantly does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Instantly API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Instantly API use? The Instantly API uses an API key sent in the Authorization header (the apiKey scheme is named 'apiKey' and bound to the Authorization header). Through Jentic, the API key sits in your encrypted Jentic One instance and is injected into the request at execution time. ### Can I pause and resume sender accounts with the API? Yes. POST `/accounts/{id}/pause` stops sending and warm-up on a given account; POST `/accounts/{id}/resume` re-enables it. This is the recommended way to react to deliverability alerts without operator intervention. ### What are the rate limits for the Instantly API? The OpenAPI specification does not encode explicit rate limits. Treat each endpoint as a single-record operation, batch lead imports rather than firing one request per lead where possible, and back off on 429 responses returned by the gateway. ### How do I create a campaign through Jentic? Install with pip install jentic, then run the search-load-execute flow with the query 'create an Instantly campaign'. Jentic returns the operation backed by POST /campaigns; the agent supplies the campaign name, schedule, and step sequence and receives the new campaign id. ### Can I read replies to my outbound campaigns? Yes. The /emails endpoints expose sent and received messages for the connected accounts, so an automation can list inbound mail, filter to replies on a specific campaign, and forward them into a CRM or helpdesk. ### Can I limit what my agent is allowed to do with the Instantly API? Yes. Because you run Jentic One yourself, your own rules decide which Instantly operations and credentials the agent may call. Since Instantly puts the account id in the URL path for calls like POST `/accounts/{id}/pause` and POST `/accounts/{id}/resume`, you can pin the agent to a single account and to only the campaign and lead operations you approve. Account creation is excluded unless you explicitly add it, so the agent never reaches operations you have not granted.