Documentation Index
Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt
Use this file to discover all available pages before exploring further.
This section documents the data models used across the Instantly API v2. Schemas are grouped by the resource domain they belong to.
Accounts & email
| Schema | Description |
|---|
| Account | An email account that can be used to send campaigns |
| Email | A campaign email, a reply, a manually sent email, or any other email that’s visible in the Unibox |
| Email Verification | A single email verification |
| Account Campaign Mapping | Mapping between accounts and campaigns |
| API Key | API key for authentication |
Campaigns & sequences
| Schema | Description |
|---|
| Campaign | A campaign that can be sent to a list of recipients |
| Campaign Subsequence | A follow-up sequence within a campaign |
Leads & lists
| Schema | Description |
|---|
| Lead | A lead entity representing an individual lead |
| Lead List | A list used to store leads |
| Lead Label | A custom label for categorizing and managing leads |
| Schema | Description |
|---|
| Custom Tag | A custom tag for organizing and categorizing accounts and campaigns |
| Custom Tag Mapping | A tag assignment connecting a tag to a campaign or email account |
| Block List Entry | A blocked email or domain |
Inbox placement
| Schema | Description |
|---|
| Inbox Placement Test | An inbox placement test |
| Inbox Placement Analytics | Analytics data for individual emails in inbox placement tests |
| Inbox Placement Blacklist & SpamAssassin Report | Report data for an inbox placement test |
Webhooks
| Schema | Description |
|---|
| Webhook | A webhook subscription for receiving event notifications |
| Webhook Event | A webhook event that was sent or attempted to be sent |
Workspace & members
| Schema | Description |
|---|
| Workspace | A workspace entity representing a workspace |
| Workspace Member | A member of a workspace with associated user details |
| Workspace Group Member | A member of a workspace group |
| Workspace Billing | Workspace billing details |
Enrichment & provisioning
| Schema | Description |
|---|
| SuperSearch Enrichment | An enrichment for leads via email or LinkedIn data |
| DFY Email Account Order | A Done-For-You email account order |
Other
| Schema | Description |
|---|
| Audit Log | Audit log records for tracking system activities |
| Background Job | A background job for long-running tasks |
| CRM Actions | CRM related actions |
| Custom Prompt Template | Custom prompt templates for creating custom prompts |
| Email Template | A campaign email template |
| Sales Flow | Manages how sales users view and interact with campaign and lead lists |
