Skip to main content
This section documents the data models used across the Instantly API v2. Schemas are grouped by the resource domain they belong to.

Accounts & email

SchemaDescription
AccountAn email account that can be used to send campaigns
EmailA campaign email, a reply, a manually sent email, or any other email that’s visible in the Unibox
Email VerificationA single email verification
Account Campaign MappingMapping between accounts and campaigns
API KeyAPI key for authentication

Campaigns & sequences

SchemaDescription
CampaignA campaign that can be sent to a list of recipients
Campaign SubsequenceA follow-up sequence within a campaign

Leads & lists

SchemaDescription
LeadA lead entity representing an individual lead
Lead ListA list used to store leads
Lead LabelA custom label for categorizing and managing leads

Tags & blocking

SchemaDescription
Custom TagA custom tag for organizing and categorizing accounts and campaigns
Custom Tag MappingA tag assignment connecting a tag to a campaign or email account
Block List EntryA blocked email or domain

Inbox placement

SchemaDescription
Inbox Placement TestAn inbox placement test
Inbox Placement AnalyticsAnalytics data for individual emails in inbox placement tests
Inbox Placement Blacklist & SpamAssassin ReportReport data for an inbox placement test

Webhooks

SchemaDescription
WebhookA webhook subscription for receiving event notifications
Webhook EventA webhook event that was sent or attempted to be sent

Workspace & members

SchemaDescription
WorkspaceA workspace entity representing a workspace
Workspace MemberA member of a workspace with associated user details
Workspace Group MemberA member of a workspace group
Workspace BillingWorkspace billing details

Enrichment & provisioning

SchemaDescription
SuperSearch EnrichmentAn enrichment for leads via email or LinkedIn data
DFY Email Account OrderA Done-For-You email account order

Other

SchemaDescription
Audit LogAudit log records for tracking system activities
Background JobA background job for long-running tasks
CRM ActionsCRM related actions
Custom Prompt TemplateCustom prompt templates for creating custom prompts
Email TemplateA campaign email template
Sales FlowManages how sales users view and interact with campaign and lead lists