Workspace Member

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

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: "019b21c4-689d-720b-aef2-92410f2d9b59"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "019b21c4-689d-720b-aef2-92424d4480a3"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "019b21c4-689d-720b-aef2-92435c9e0d1e"

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-12-15T11:27:58.622Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-12-15T11:27:58.622Z"

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": "019b21c4-689d-720b-aef2-92410f2d9b59",
  "admin_workspace_id": "019b21c4-689d-720b-aef2-92424d4480a3",
  "sub_workspace_id": "019b21c4-689d-720b-aef2-92435c9e0d1e",
  "status": "accepted",
  "timestamp_created": "2025-12-15T11:27:58.622Z",
  "timestamp_updated": "2025-12-15T11:27:58.622Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Workspace Member

A member of a workspace with associated user details

idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "019b21c4-68a0-748f-b726-14f8e01f0230"

emailstring(email)required

Email address of the workspace member

Example: "user@example.com"

user_idstring(uuid)read-onlyrequired

User ID of the workspace member

Example: "019b21c4-68a0-748f-b726-14f9f11aa09e"

rolestringrequired

THe role of the workspace member defining their access level. While the "owner" role is listed in the enum, it cannot be created via the API, and is only assigned to the user who creates the workspace.

Enum Value	Description
owner	Owner - Full access and workspace management
admin	Admin - Full access except workspace deletion
editor	Editor - Can edit but not manage workspace settings
view	View - Read-only access
client	This is a special role for users in the whitelabel (agency) view. It is not available in the API.

Example: "editor"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-12-15T11:27:58.624Z"

workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "019b21c4-68a0-748f-b726-14fa6bd9262c"

acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false

user_emailnull or string(email)

Email address of the user

Example: "user@example.com"

nameobjectread-only

issuer_idnull or string(uuid)read-only

ID of the user who added this member to the workspace

Example: "019b21c4-68a0-748f-b726-14fb54e04a20"

permissionsArray of strings or null

The permissions for this workspace member. Used in the app to restrict access to certain sections

Enum Value	Description
dashboard.view	View the dashboard
campaigns.view	View campaigns
campaigns.create	Create campaigns
campaigns.edit	Edit campaigns
campaigns.delete	Delete campaigns
organization.manage	Manage organization
organization.integrations	Manage organization integrations
organization.billing	Manage organization billing
organization.users.manage	Manage organization users
leadFinder.view	View lead finder

{
  "id": "019b21c4-68a0-748f-b726-14f8e01f0230",
  "email": "user@example.com",
  "user_id": "019b21c4-68a0-748f-b726-14f9f11aa09e",
  "user_email": "user@example.com",
  "name": {
    "first": "John",
    "last": "Smith"
  },
  "role": "editor",
  "timestamp_created": "2025-12-15T11:27:58.624Z",
  "workspace_id": "019b21c4-68a0-748f-b726-14fa6bd9262c",
  "accepted": false,
  "issuer_id": "019b21c4-68a0-748f-b726-14fb54e04a20",
  "permissions": null
}

Campaign Subsequence

A subsequence entity representing a follow-up sequence

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "019b21c4-68a2-7e87-9dda-9bb19226efde"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-12-15T11:27:58.626Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "019b21c4-68a2-7e87-9dda-9bb2dec0390f"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "019b21c4-68a2-7e87-9dda-9bb3c926a1a5"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-12-15T11:27:58.626Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Lead CRM statuses that trigger the subsequence.

Items Enum Value	Description
0	Out of Office
1	Interested
2	Meeting Booked
3	Meeting Completed
4	Closed
-1	Not Interested
-2	Wrong Person
-3	Lost

Example: [1]

conditions.lead_activityArray of numbers

Items Enum4912

Example: [4]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datenull or string(date)

Start date in YYYY-MM-DD format. Uses the campaign's timezone.

Example: "2025-09-25"

subsequence_schedule.end_datenull or string(date)

End date in YYYY-MM-DD format. Uses the campaign's timezone.

Example: "2025-09-25"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

sequences[].steps[].variants[].v_disabledboolean

Whether this variant is disabled. By default, all the variants are enabled. Please set this to true if you want to disable this variant

Example: true

{
  "id": "019b21c4-68a2-7e87-9dda-9bb19226efde",
  "timestamp_created": "2025-12-15T11:27:58.626Z",
  "parent_campaign": "019b21c4-68a2-7e87-9dda-9bb2dec0390f",
  "workspace": "019b21c4-68a2-7e87-9dda-9bb3c926a1a5",
  "status": 0,
  "timestamp_leads_updated": "2025-12-15T11:27:58.626Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "lead_activity": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-09-25",
    "end_date": "2025-09-25",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}