DFY Email Account Order

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.

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

Operations

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

Custom Tag Mapping

This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.

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

Custom Prompt Template

Custom prompt templates for creating custom prompts

Sales Flow

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

Email Template

A campaign email template

Workspace Billing

Operations

CRM Actions

CRM related actions

Operations

Schemas

Webhook Event

A webhook event that was sent or attempted to be sent

idstring(uuid)read-onlyrequired

Unique identifier for the webhook event (UUID)

Example: "019afb5d-41a5-79c5-bf99-e6ebecc4c3c0"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the webhook event was created

Example: "2025-12-08T00:29:44.229Z"

timestamp_created_datestring(date)read-onlyrequired

Date when the webhook event was created (for partitioning)

Example: "2024-01-15"

organization_idstring(uuid)read-onlyrequired

Organization (workspace) UUID that owns this webhook event

Example: "019afb5d-41a5-79c5-bf99-e6ecae85df25"

successbooleanread-onlyrequired

Whether the webhook call was successful

Example: true

retry_countnumberread-onlyrequired

Number of retry attempts made

Example: 0

will_retrybooleanread-onlyrequired

Whether the webhook will be retried

Example: false

webhook_urlstringread-onlyrequired

Target URL where the webhook was sent

Example: "https://webhook.site/unique-url"

payloadobjectread-only

JSON payload that was sent/attempted to be sent

status_codenull or numberread-only

HTTP status code received from the webhook endpoint (if any)

Example: 200

error_messagenull or stringread-only

Error message if the webhook failed

Example: "Connection timeout"

timestamp_next_retrynull or string(date-time)read-only

Timestamp for the next retry attempt (if applicable)

Example: "2025-12-08T00:29:44.229Z"

retry_group_idnull or string(uuid)read-only

UUID for grouping retry attempts

Example: "019afb5d-41a5-79c5-bf99-e6ed12ee61fa"

retry_successfulnull or booleanread-only

Whether the retry was successful (for retry events)

Example: true

lead_emailnull or stringread-only

Email address of the lead associated with this webhook event

Example: "lead@example.com"

response_time_msnull or numberread-only

Response time in milliseconds for the webhook call

Example: 150

{
  "id": "019afb5d-41a5-79c5-bf99-e6ebecc4c3c0",
  "timestamp_created": "2025-12-08T00:29:44.229Z",
  "timestamp_created_date": "2024-01-15",
  "organization_id": "019afb5d-41a5-79c5-bf99-e6ecae85df25",
  "payload": {},
  "success": true,
  "retry_count": 0,
  "will_retry": false,
  "webhook_url": "https://webhook.site/unique-url",
  "status_code": 200,
  "error_message": "Connection timeout",
  "timestamp_next_retry": "2025-12-08T00:29:44.229Z",
  "retry_group_id": "019afb5d-41a5-79c5-bf99-e6ed12ee61fa",
  "retry_successful": true,
  "lead_email": "lead@example.com",
  "response_time_ms": 150
}

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-12-08T00:29:44.231Z"

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-12-08T00:29:44.231Z"

{
  "workspace_id": "workspace_12345",
  "domain": "example.com",
  "forwarding_domain": "forward.example.com",
  "is_pre_warmed_up": true,
  "timestamp_cancelled": "2025-12-08T00:29:44.231Z",
  "timestamp_created": "2025-12-08T00:29:44.231Z"
}

Custom Prompt Template

Custom prompt templates for creating custom prompts

idnumberread-onlyrequired

Example: 1

workspace_idstring(uuid)read-onlyrequired

Example: "019afb5d-41af-708b-a275-3a71c58bc551"

created_bystring(uuid)read-onlyrequired

Example: "019afb5d-41af-708b-a275-3a7296b2a5f5"

namestringrequired

Example: "Prompt template name"

categorynumberrequired

Prompt Custom template category

Enum Value	Description
1	Copywriting
2	Cleaning
3	Sales
4	Marketing
5	Other
6	Personalization

Example: 1

promptstringrequired

Example: "Generate a name using {{property_1}} and {{property_2}} combination."

is_publicbooleanrequired

Example: true

descriptionnull or string

Example: "Prompt template description"

propertiesArray of objects or null

model_versionstring

Enum Value	Description
3.5	GPT-3.5
gpt-5	GPT-5
gpt-5-mini	GPT-5 Mini
gpt-5-nano	GPT-5 Nano
4.0	GPT-4.0
4.0-Omni	GPT-4.0 Omni
gpt-4o	GPT-4O
o3	O3
gpt-4.1	GPT-4.1
gpt-4.1-mini	GPT-4.1 Mini

Example: "3.5"

from_sharednull or boolean

Example: false

like_countnull or numberread-only

Example: 50

execution_countnull or numberread-only

Example: 20

likednull or booleanread-only

Example: true

template_typenull or string

Custom Prompt template type

Enum Value	Description
custom	custom
public	public

Example: "public"

created_by_instantlynull or booleanread-only

Example: true

creatornull or objectread-only

{
  "id": 1,
  "workspace_id": "019afb5d-41af-708b-a275-3a71c58bc551",
  "created_by": "019afb5d-41af-708b-a275-3a7296b2a5f5",
  "name": "Prompt template name",
  "description": "Prompt template description",
  "category": 1,
  "properties": null,
  "prompt": "Generate a name using {{property_1}} and {{property_2}} combination.",
  "is_public": true,
  "model_version": "3.5",
  "from_shared": false,
  "like_count": 50,
  "execution_count": 20,
  "liked": true,
  "template_type": "public",
  "created_by_instantly": true,
  "creator": null
}