Workspace

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

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

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

Schemas

Lead Label

A custom label for categorizing and managing leads

idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "019769d6-c13b-7236-b6d9-df9f410b8966"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-06-13T15:09:31.323Z"

created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "019769d6-c13b-7236-b6d9-dfa000eaf592"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "019769d6-c13b-7236-b6d9-dfa173f242f8"

labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"

interest_status_labelstringrequired

Interest status label associated with this label

Enum Value	Description
positive	Positive
negative	Negative
neutral	Neutral

Example: "positive"

interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1

descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"

use_with_ainull or boolean

Whether this label should be used with AI features

Example: false

{
  "id": "019769d6-c13b-7236-b6d9-df9f410b8966",
  "timestamp_created": "2025-06-13T15:09:31.323Z",
  "created_by": "019769d6-c13b-7236-b6d9-dfa000eaf592",
  "organization_id": "019769d6-c13b-7236-b6d9-dfa173f242f8",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

Workspace

A workspace entity representing a workspace

idstring(uuid)read-onlyrequired

Unique identifier for the workspace

Example: "019769d6-c141-76d2-b082-b6f6941114c3"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace was created

Example: "2025-06-13T15:09:31.329Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the workspace was last updated

Example: "2025-06-13T15:09:31.329Z"

ownerstring(uuid)required

User ID of the workspace owner

Example: "019769d6-c141-76d2-b082-b6f7eb3fd1e6"

namestringrequired

Name of the workspace

Example: "My Workspace"

plan_idnull or stringread-only

Plan ID for workspace

Example: "pid_hg_v1"

add_unsub_to_blocknull or boolean

Whether to add unsubscribes to block list

Example: false

default_opportunity_valuenull or number

Default value for opportunities

Example: 250

plan_id_leadfindernull or stringread-only

Plan ID for leadfinder

Example: "pid_lf_ls_v1"

plan_id_verificationobjectread-only

Plan ID for verification service

org_logo_urlnull or stringread-only

URL to workspace logo

Example: "https://example.com/logo.png"

org_client_domainnull or stringread-only

The domain for the white label agency mode

Example: "example.com"

plan_id_crmnull or stringread-only

Plan ID for CRM

Example: "pid_crm_v1"

plan_id_website_visitornull or stringread-only

Plan ID for website visitor tracking

Example: "pid_wvw_v1"

plan_id_inbox_placementnull or stringread-only

Plan ID for inbox placement

Example: "pid_ip_v1"

{
  "id": "019769d6-c141-76d2-b082-b6f6941114c3",
  "timestamp_created": "2025-06-13T15:09:31.329Z",
  "timestamp_updated": "2025-06-13T15:09:31.329Z",
  "owner": "019769d6-c141-76d2-b082-b6f7eb3fd1e6",
  "name": "My Workspace",
  "plan_id": "pid_hg_v1",
  "add_unsub_to_block": false,
  "default_opportunity_value": 250,
  "plan_id_leadfinder": "pid_lf_ls_v1",
  "plan_id_verification": {
    "quantity": 5,
    "product_id": "pid_verify_v1_monthly",
    "timestamp_updated": "2024-07-22T05:56:58.667Z"
  },
  "org_logo_url": "https://example.com/logo.png",
  "org_client_domain": "example.com",
  "plan_id_crm": "pid_crm_v1",
  "plan_id_website_visitor": "pid_wvw_v1",
  "plan_id_inbox_placement": "pid_ip_v1"
}

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.

idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "019769d6-c149-73dc-8f58-2710cffe28a6"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "019769d6-c149-73dc-8f58-27115aea5024"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "019769d6-c149-73dc-8f58-2712ee7ffdf6"

statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

timestamp_createdstring(date-time)read-onlyrequired

Example: "2025-06-13T15:09:31.337Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-06-13T15:09:31.337Z"

sub_workspace_namenull or stringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namenull or stringread-only

The name of the admin workspace.

Example: "My Workspace"

{
  "id": "019769d6-c149-73dc-8f58-2710cffe28a6",
  "admin_workspace_id": "019769d6-c149-73dc-8f58-27115aea5024",
  "sub_workspace_id": "019769d6-c149-73dc-8f58-2712ee7ffdf6",
  "status": "accepted",
  "timestamp_created": "2025-06-13T15:09:31.337Z",
  "timestamp_updated": "2025-06-13T15:09:31.337Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}