Schemas
/
Sales Flow

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

SuperSearch Enrichment

An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it.

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Webhook Event

A webhook event that was sent or attempted to be sent

Operations

DFY Email Account Order

A Done-For-You email account order

Operations

Sales Flow

Manages how sales users view and interact with campaign and lead lists within the sales flow.

Schemas

DFY Email Account Order

A Done-For-You email account order

workspace_idstringread-onlyrequired

ID of the workspace associated with the email account order

Example: "workspace_12345"
domainstringread-onlyrequired

Domain of the email account

Example: "example.com"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the order was created

Example: "2025-10-24T20:44:08.351Z"
forwarding_domainnull or string

Forwarding domain for the email account, if any

Example: "forward.example.com"
is_pre_warmed_upnull or boolean

Indicates if the account is pre-warmed up

Example: true
timestamp_cancellednull or string(date-time)read-only

Timestamp when the order was cancelled, if applicable

Example: "2025-10-24T20:44:08.351Z"
{
  "workspace_id": "workspace_12345",
  "domain": "example.com",
  "forwarding_domain": "forward.example.com",
  "is_pre_warmed_up": true,
  "timestamp_cancelled": "2025-10-24T20:44:08.351Z",
  "timestamp_created": "2025-10-24T20:44:08.351Z"
}

Sales Flow

Manages how sales users view and interact with campaign and lead lists within the sales flow.

idstring(uuid)read-onlyrequired
Example: "019a17f6-e722-7284-8da0-e834d4ae6c48"
timestamp_createdstring(date-time)read-onlyrequired

Date and time when sales flow created

Example: "2025-10-24T20:44:08.354Z"
organization_idstring(uuid)read-onlyrequired

Organization ID associated with the sales flow

Example: "019a17f6-e722-7284-8da0-e8355f982882"
namestringrequired

Name of the sales flow

Example: "Smart view name"
queriesArray of objectsrequired

An object containing the sales flow queries

Example: [{"actionType":"email-open","values":{"occurrence-days":1}}]
queries[].​actionTypestringrequired
Enum"reply""email-open""last-contacted""link-click""lead-status""lead-status-change"
Example: "email-open"
queries[].​valuesobjectrequired
Example: {"occurrence-days":1}
queries[].​values.​occurrence-daysnumber
Example: 1
queries[].​values.​occurrence-countobject
queries[].​values.​lead-statusobject
created_bystring(uuid)read-onlyrequired

UUID of the user who created the sales flow.

Example: "019a17f6-e722-7284-8da0-e836a5eeba45"
is_defaultnull or boolean

Indicates whether this sales flow is set as the default one for the user or workspace.

Example: true
list_idnull or string

The ID of the list, can be "all-lists" in case of all.

Example: "019a17f6-e722-7284-8da0-e8374cfceac5"
campaign_idnull or string

The ID of the campaign. Set to null when "all-campaigns" is passed.

Example: "019a17f6-e722-7284-8da0-e838be8d4d8b"
list_namenull or stringread-only

The name of the list.

Example: "List name"
campaign_namenull or stringread-only

The name of the campaign.

Example: "Campaign #1"
{
  "id": "019a17f6-e722-7284-8da0-e834d4ae6c48",
  "timestamp_created": "2025-10-24T20:44:08.354Z",
  "organization_id": "019a17f6-e722-7284-8da0-e8355f982882",
  "name": "Smart view name",
  "is_default": true,
  "queries": [
    { … }
  ],
  "created_by": "019a17f6-e722-7284-8da0-e836a5eeba45",
  "list_id": "019a17f6-e722-7284-8da0-e8374cfceac5",
  "campaign_id": "019a17f6-e722-7284-8da0-e838be8d4d8b",
  "list_name": "List name",
  "campaign_name": "Campaign #1"
}