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.

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 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

Workspace Member

A member of a workspace with associated user details

idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"
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: "01959271-1f8b-75f2-be1d-5be578ad3a68"
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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"
workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"
acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false
issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
{
  "id": "01959271-1f8b-75f2-be1d-5be4942ab332",
  "email": "user@example.com",
  "user_id": "01959271-1f8b-75f2-be1d-5be578ad3a68",
  "role": "editor",
  "timestamp_created": "2025-03-14T02:17:22.059Z",
  "workspace_id": "01959271-1f8b-75f2-be1d-5be63d29ce8b",
  "accepted": false,
  "issuer_id": "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
}

Create workspace member

Request

Requires one of the following scopes: workspace_members:create, workspace_members:all, all:create, all:all

Bodyapplication/jsonrequired

The Workspace Member to create

emailstring(email)required

Email address of the workspace member

Example: "user@example.com"
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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
curl -i -X POST \
  https://api.instantly.ai/api/v2/workspace-members \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "role": "editor"
  }'

Responses

The Workspace Member

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"
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: "01959271-1f8b-75f2-be1d-5be578ad3a68"
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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"
workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"
acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false
issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
Response
application/json
{
  "id": "01959271-1f8b-75f2-be1d-5be4942ab332",
  "email": "user@example.com",
  "user_id": "01959271-1f8b-75f2-be1d-5be578ad3a68",
  "role": "editor",
  "timestamp_created": "2025-03-14T02:17:22.059Z",
  "workspace_id": "01959271-1f8b-75f2-be1d-5be63d29ce8b",
  "accepted": false,
  "issuer_id": "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
}

List workspace member

Request

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

Query
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring(uuid)

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084
curl -i -X GET \
  'https://api.instantly.ai/api/v2/workspace-members?limit=10&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Workspace Member

Bodyapplication/json
itemsArray of objects(Workspace Member)required
items[].​idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"
items[].​emailstring(email)required

Email address of the workspace member

Example: "user@example.com"
items[].​user_idstring(uuid)read-onlyrequired

User ID of the workspace member

Example: "01959271-1f8b-75f2-be1d-5be578ad3a68"
items[].​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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
items[].​timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"
items[].​workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"
items[].​acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false
items[].​issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0000-0000-0000-0000"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

Get workspace member

Request

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

Path
idstringrequired
curl -i -X GET \
  'https://api.instantly.ai/api/v2/workspace-members/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Workspace Member

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"
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: "01959271-1f8b-75f2-be1d-5be578ad3a68"
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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"
workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"
acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false
issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
Response
application/json
{
  "id": "01959271-1f8b-75f2-be1d-5be4942ab332",
  "email": "user@example.com",
  "user_id": "01959271-1f8b-75f2-be1d-5be578ad3a68",
  "role": "editor",
  "timestamp_created": "2025-03-14T02:17:22.059Z",
  "workspace_id": "01959271-1f8b-75f2-be1d-5be63d29ce8b",
  "accepted": false,
  "issuer_id": "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
}

Patch workspace member

Request

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

Path
idstringrequired
Bodyapplication/json
non-empty
rolestring

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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
curl -i -X PATCH \
  'https://api.instantly.ai/api/v2/workspace-members/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Workspace Member

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"
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: "01959271-1f8b-75f2-be1d-5be578ad3a68"
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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"
workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"
acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false
issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
Response
application/json
{
  "id": "01959271-1f8b-75f2-be1d-5be4942ab332",
  "email": "user@example.com",
  "user_id": "01959271-1f8b-75f2-be1d-5be578ad3a68",
  "role": "editor",
  "timestamp_created": "2025-03-14T02:17:22.059Z",
  "workspace_id": "01959271-1f8b-75f2-be1d-5be63d29ce8b",
  "accepted": false,
  "issuer_id": "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
}

Delete workspace member

Request

Requires one of the following scopes: workspace_members:delete, workspace_members:all, all:delete, all:all

Path
idstringrequired
curl -i -X DELETE \
  'https://api.instantly.ai/api/v2/workspace-members/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The deleted Workspace Member

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"
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: "01959271-1f8b-75f2-be1d-5be578ad3a68"
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 ValueDescription
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

any

Any - Special role for permission checks

Example: "editor"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"
workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"
acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false
issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
Response
application/json
{
  "id": "01959271-1f8b-75f2-be1d-5be4942ab332",
  "email": "user@example.com",
  "user_id": "01959271-1f8b-75f2-be1d-5be578ad3a68",
  "role": "editor",
  "timestamp_created": "2025-03-14T02:17:22.059Z",
  "workspace_id": "01959271-1f8b-75f2-be1d-5be63d29ce8b",
  "accepted": false,
  "issuer_id": "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
}

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Schemas