Workspace
/
Patch 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.

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 items

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

A workspace entity representing a workspace

idstring(uuid)read-onlyrequired

Unique identifier for the workspace

Example: "01959271-1f84-7174-aa83-67493f9a32b9"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace was created

Example: "2025-03-14T02:17:22.052Z"
timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the workspace was last updated

Example: "2025-03-14T02:17:22.052Z"
ownerstring(uuid)required

User ID of the workspace owner

Example: "01959271-1f84-7174-aa83-674a21e6bb74"
namestringrequired

Name of the workspace

Example: "My Workspace"
plan_idstringread-only

Plan ID for workspace

Example: "pid_hg_v1"
add_unsub_to_blockboolean

Whether to add unsubscribes to block list

Example: false
default_opportunity_valuenumber

Default value for opportunities

Example: 250
plan_id_leadfinderstringread-only

Plan ID for leadfinder

Example: "pid_lf_ls_v1"
plan_id_verificationstringread-only

Plan ID for verification service

Example: "pid_vf_v1"
org_logo_urlstringread-only

URL to workspace logo

Example: "https://example.com/logo.png"
org_client_domainstringread-only

The domain for the white label agency mode

Example: "example.com"
plan_id_crmstringread-only

Plan ID for CRM

Example: "pid_crm_v1"
plan_id_website_visitorstringread-only

Plan ID for website visitor tracking

Example: "pid_wvw_v1"
plan_id_inbox_placementstringread-only

Plan ID for inbox placement

Example: "pid_ip_v1"
{
  "id": "01959271-1f84-7174-aa83-67493f9a32b9",
  "timestamp_created": "2025-03-14T02:17:22.052Z",
  "timestamp_updated": "2025-03-14T02:17:22.052Z",
  "owner": "01959271-1f84-7174-aa83-674a21e6bb74",
  "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": "pid_vf_v1",
  "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"
}

Get workspace

Request

Get your current workspace details. Note that this endpoint doesn't require any parameters. It will return the workspace based on the API key sent in the headers.

Requires one of the following scopes: workspaces:read, workspaces:all, all:read, all:all

curl -i -X GET \
  https://api.instantly.ai/api/v2/workspaces/current \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Workspace

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the workspace

Example: "01959271-1f84-7174-aa83-67493f9a32b9"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace was created

Example: "2025-03-14T02:17:22.052Z"
timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the workspace was last updated

Example: "2025-03-14T02:17:22.052Z"
ownerstring(uuid)required

User ID of the workspace owner

Example: "01959271-1f84-7174-aa83-674a21e6bb74"
namestringrequired

Name of the workspace

Example: "My Workspace"
plan_idstringread-only

Plan ID for workspace

Example: "pid_hg_v1"
add_unsub_to_blockboolean

Whether to add unsubscribes to block list

Example: false
default_opportunity_valuenumber

Default value for opportunities

Example: 250
plan_id_leadfinderstringread-only

Plan ID for leadfinder

Example: "pid_lf_ls_v1"
plan_id_verificationstringread-only

Plan ID for verification service

Example: "pid_vf_v1"
org_logo_urlstringread-only

URL to workspace logo

Example: "https://example.com/logo.png"
org_client_domainstringread-only

The domain for the white label agency mode

Example: "example.com"
plan_id_crmstringread-only

Plan ID for CRM

Example: "pid_crm_v1"
plan_id_website_visitorstringread-only

Plan ID for website visitor tracking

Example: "pid_wvw_v1"
plan_id_inbox_placementstringread-only

Plan ID for inbox placement

Example: "pid_ip_v1"
Response
application/json
{
  "id": "01959271-1f84-7174-aa83-67493f9a32b9",
  "timestamp_created": "2025-03-14T02:17:22.052Z",
  "timestamp_updated": "2025-03-14T02:17:22.052Z",
  "owner": "01959271-1f84-7174-aa83-674a21e6bb74",
  "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": "pid_vf_v1",
  "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"
}

Patch workspace

Request

Update your current workspace details. Note that this endpoint doesn't require any parameters. It will update the workspace based on the API key sent in the headers.

Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all

Bodyapplication/json
non-empty
namestring

Name of the workspace

Example: "My Workspace"
curl -i -X PATCH \
  https://api.instantly.ai/api/v2/workspaces/current \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Workspace

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the workspace

Example: "01959271-1f84-7174-aa83-67493f9a32b9"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace was created

Example: "2025-03-14T02:17:22.052Z"
timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the workspace was last updated

Example: "2025-03-14T02:17:22.052Z"
ownerstring(uuid)required

User ID of the workspace owner

Example: "01959271-1f84-7174-aa83-674a21e6bb74"
namestringrequired

Name of the workspace

Example: "My Workspace"
plan_idstringread-only

Plan ID for workspace

Example: "pid_hg_v1"
add_unsub_to_blockboolean

Whether to add unsubscribes to block list

Example: false
default_opportunity_valuenumber

Default value for opportunities

Example: 250
plan_id_leadfinderstringread-only

Plan ID for leadfinder

Example: "pid_lf_ls_v1"
plan_id_verificationstringread-only

Plan ID for verification service

Example: "pid_vf_v1"
org_logo_urlstringread-only

URL to workspace logo

Example: "https://example.com/logo.png"
org_client_domainstringread-only

The domain for the white label agency mode

Example: "example.com"
plan_id_crmstringread-only

Plan ID for CRM

Example: "pid_crm_v1"
plan_id_website_visitorstringread-only

Plan ID for website visitor tracking

Example: "pid_wvw_v1"
plan_id_inbox_placementstringread-only

Plan ID for inbox placement

Example: "pid_ip_v1"
Response
application/json
{
  "id": "01959271-1f84-7174-aa83-67493f9a32b9",
  "timestamp_created": "2025-03-14T02:17:22.052Z",
  "timestamp_updated": "2025-03-14T02:17:22.052Z",
  "owner": "01959271-1f84-7174-aa83-674a21e6bb74",
  "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": "pid_vf_v1",
  "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.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Schemas