CRM Actions

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

Workspace Billing

Operations

CRM Actions

CRM related actions

Operations

CRM Actions

CRM related actions

object(CRM Actions)

CRM related actions

{}

List phone numbers

Request

Retrieve all phone numbers associated with the current organization.

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

curl -i -X GET \
  https://api.instantly.ai/api/v2/crm-actions/phone-numbers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
idstring

Unique identifier of the phone number record.

Example: "019b8a2d-d117-7efe-b481-3f1048b8c0d1"
timestamp_createdstring(date-time)

Timestamp when the phone number record was created.

Example: "2026-01-04T18:03:37.111Z"
organization_idstring

Identifier of the organization that owns this phone number.

Example: "019b8a2d-d117-7efe-b481-3f113a7e5b09"
phone_numberstring

The phone number in international E.164 format.

Example: "+15551234567"
countrystring

Country code where the phone number is registered.

Example: "US"
localitystring

City or region associated with the phone number.

Example: "San Francisco"
subscription_idstring

Billing subscription ID linked to this phone number.

Example: "sub_1PuaE1B3VEKBA0ygDAKk7QVc"
twilio_sidstring

Twilio resource SID for the phone number.

Example: "PN998dda028e07a49c8038b2206341d463"
renewal_datestring(date)

Next renewal date for the phone number subscription.

Example: "2026-01-04T18:03:37.111Z"
pricenumber

Monthly price for this phone number (USD).

Example: 1
]
Response
application/json
[
  {
    "id": "019b8a2d-d117-7efe-b481-3f1048b8c0d1",
    "timestamp_created": "2026-01-04T18:03:37.111Z",
    "organization_id": "019b8a2d-d117-7efe-b481-3f113a7e5b09",
    "phone_number": "+15551234567",
    "country": "US",
    "locality": "San Francisco",
    "subscription_id": "sub_1PuaE1B3VEKBA0ygDAKk7QVc",
    "twilio_sid": "PN998dda028e07a49c8038b2206341d463",
    "renewal_date": "2026-01-04T18:03:37.111Z",
    "price": 1
  }
]

Delete phone number

Request

Delete a specific phone number from the organization.

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

Path
idstringrequired

The phone number record id to delete

Example: 019b8a2d-d118-79c1-b6ea-be0f3bdbe5d2
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/crm-actions/phone-numbers/019b8a2d-d118-79c1-b6ea-be0f3bdbe5d2 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
idstring

Unique identifier of the deleted phone number record.

Example: "019b8a2d-d119-71f3-b2d6-e0d01df26f4f"
timestamp_createdstring(date-time)

Timestamp when the deleted record was originally created.

Example: "2026-01-04T18:03:37.113Z"
organization_idstring

Identifier of the organization that owned the phone number.

Example: "019b8a2d-d119-71f3-b2d6-e0d1d07efcc4"
phone_numberstring

The deleted phone number.

Example: "+15551234567"
countrystring

Country code of the deleted phone number.

Example: "US"
localitystring

Region or city associated with the deleted phone number.

Example: "San Francisco"
subscription_idstring

Billing subscription ID associated with this number (if any).

Example: "sub_1PuaE1B3VEKBA0ygDAKk7QVc"
twilio_sidstring

Twilio SID of the deleted number.

Example: "PN998dda028e07a49c8038b2206341d463"
Response
application/json
{
  "id": "019b8a2d-d119-71f3-b2d6-e0d01df26f4f",
  "timestamp_created": "2026-01-04T18:03:37.113Z",
  "organization_id": "019b8a2d-d119-71f3-b2d6-e0d1d07efcc4",
  "phone_number": "+15551234567",
  "country": "US",
  "locality": "San Francisco",
  "subscription_id": "sub_1PuaE1B3VEKBA0ygDAKk7QVc",
  "twilio_sid": "PN998dda028e07a49c8038b2206341d463"
}

Schemas