string
Overview
Add Instantly to any ModuleX agent or workflow. Cold-email outreach automation against the Instantly V2 REST API (api.instantly.ai). Manage leads, lead lists, campaigns, and Unibox emails.
Categories: Marketing & Advertising · Email · Sales Engagement · Auth: API Key · Actions: 13
Authentication
API Key Authentication
Authenticate using your Instantly V2 API key1
Step 1
Sign in at https://app.instantly.ai
2
Step 2
Open Settings and navigate to the ‘API Keys’ (Integrations) section
3
Step 3
Create a new V2 API key with the required scopes
4
Step 4
Copy the key and paste it below
Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Instantly API Key | Your Instantly V2 API key with the required scopes | Yes | - |
Available Actions
list_leads — Retrieve leads with search, campaign, list, and pagination filters.
list_leads — Retrieve leads with search, campaign, list, and pagination filters.
Parameters
string
Search by first name, last name, or email
string
Lead filter value, such as FILTER_VAL_CONTACTED or FILTER_VAL_ACTIVE
string
Campaign ID to filter leads
string
Lead list ID to filter leads
boolean
Whether the lead is in a campaign
boolean
Whether the lead is in a list
array
Lead IDs to include
array
Lead IDs to exclude
array
Lead email addresses to include
array
Organization user IDs to filter leads
string
Smart view ID to filter leads
boolean
Whether the lead is a website visitor
boolean
Whether to return distinct contacts
integer
Enrichment status filter
string
Email security gateway code filter
integer
Number of leads to return, from 1 to 100
string
Forward pagination cursor from next_starting_after
Response
{
"$defs": {
"LeadDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"organization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization"
},
"campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"personalization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Personalization"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Website"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Company Name"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Job Title"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phone"
},
"email_open_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Open Count"
},
"email_reply_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Reply Count"
},
"email_click_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Click Count"
},
"company_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Company Domain"
},
"payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payload"
},
"lt_interest_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Lt Interest Status"
}
},
"title": "LeadDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"leads": {
"items": {
"$ref": "#/$defs/LeadDetail"
},
"title": "Leads",
"type": "array"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"next_starting_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Starting After"
}
},
"required": [
"success"
],
"title": "ListLeadsOutput",
"type": "object"
}
get_lead — Retrieve a lead by ID.
get_lead — Retrieve a lead by ID.
Parameters
string
required
Lead ID
Response
{
"$defs": {
"LeadDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"organization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization"
},
"campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"personalization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Personalization"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Website"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Company Name"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Job Title"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phone"
},
"email_open_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Open Count"
},
"email_reply_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Reply Count"
},
"email_click_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Click Count"
},
"company_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Company Domain"
},
"payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payload"
},
"lt_interest_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Lt Interest Status"
}
},
"title": "LeadDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"lead": {
"anyOf": [
{
"$ref": "#/$defs/LeadDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "GetLeadOutput",
"type": "object"
}
create_lead — Create a lead in a campaign or lead list.
create_lead — Create a lead in a campaign or lead list.
Parameters
string
Campaign ID associated with the lead
string
Lead list ID associated with the lead
string
Lead email address. Required when adding to a campaign.
string
Lead first name
string
Lead last name
string
Lead company name
string
Lead job title
string
Lead phone number
string
Lead website
string
Lead personalization text
integer
Lead interest status value
string
Potential value of the lead
string
Organization user ID assigned to the lead
boolean
Skip if the lead already exists in the workspace
boolean
Skip if the lead already exists in the campaign
boolean
Skip if the lead already exists in the list
string
Blocklist ID to check for the lead
boolean
Whether to verify leads imported from Lead Finder
boolean
Whether to verify leads on import
object
Custom variable object with string, number, boolean, or null values
Response
{
"$defs": {
"LeadDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"organization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization"
},
"campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"personalization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Personalization"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Website"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Company Name"
},
"job_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Job Title"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phone"
},
"email_open_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Open Count"
},
"email_reply_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Reply Count"
},
"email_click_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Click Count"
},
"company_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Company Domain"
},
"payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payload"
},
"lt_interest_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Lt Interest Status"
}
},
"title": "LeadDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"lead": {
"anyOf": [
{
"$ref": "#/$defs/LeadDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "CreateLeadOutput",
"type": "object"
}
delete_leads — Delete leads in bulk from a campaign or lead list.
delete_leads — Delete leads in bulk from a campaign or lead list.
Parameters
string
Campaign ID to delete leads from. Required if list_id is not provided.
string
Lead list ID to delete leads from. Required if campaign_id is not provided.
integer
Optional lead status filter
array
Specific lead IDs to delete
integer
Maximum number of matching leads to delete, up to 10000
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
}
},
"required": [
"success"
],
"title": "DeleteLeadsOutput",
"type": "object"
}
update_lead_interest_status — Submit a background job to update a lead interest status.
update_lead_interest_status — Submit a background job to update a lead interest status.
Parameters
string
required
Lead email address
integer
Interest status value. Pass null to reset to Lead.
string
Campaign ID for the lead
string
Lead list ID for the lead
integer
AI interest value to set for the lead
boolean
Whether to disable auto interest
Response
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
}
},
"required": [
"success"
],
"title": "UpdateLeadInterestStatusOutput",
"type": "object"
}
list_campaigns — Retrieve campaigns with search, status, tag, and pagination filters.
list_campaigns — Retrieve campaigns with search, status, tag, and pagination filters.
Parameters
integer
Number of campaigns to return, from 1 to 100
string
Pagination cursor from next_starting_after
string
Search by campaign name
string
Comma-separated campaign tag IDs
string
AI Sales Agent ID filter
integer
Campaign status enum value
Response
{
"$defs": {
"CampaignDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"pl_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Pl Value"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"is_evergreen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Evergreen"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"email_gap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Gap"
},
"daily_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Limit"
},
"daily_max_leads": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Max Leads"
},
"open_tracking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Open Tracking"
},
"stop_on_reply": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Stop On Reply"
},
"sequences": {
"items": {},
"title": "Sequences",
"type": "array"
},
"campaign_schedule": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign Schedule"
}
},
"title": "CampaignDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"campaigns": {
"items": {
"$ref": "#/$defs/CampaignDetail"
},
"title": "Campaigns",
"type": "array"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"next_starting_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Starting After"
}
},
"required": [
"success"
],
"title": "ListCampaignsOutput",
"type": "object"
}
create_campaign — Create a campaign using the documented campaign schedule schema.
create_campaign — Create a campaign using the documented campaign schedule schema.
Parameters
string
required
Campaign name
object
required
Campaign schedule object with schedules array
array
Campaign sequence definitions
array
Sending email accounts
integer
Daily sending limit
integer
Daily maximum new leads to contact
boolean
Whether to track opens
boolean
Whether to stop the campaign on reply
boolean
Whether to track links
boolean
Whether the campaign is text only
integer
Gap between emails in minutes
number
Value of every positive lead
Response
{
"$defs": {
"CampaignDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"pl_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Pl Value"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"is_evergreen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Evergreen"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"email_gap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Gap"
},
"daily_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Limit"
},
"daily_max_leads": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Max Leads"
},
"open_tracking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Open Tracking"
},
"stop_on_reply": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Stop On Reply"
},
"sequences": {
"items": {},
"title": "Sequences",
"type": "array"
},
"campaign_schedule": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign Schedule"
}
},
"title": "CampaignDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"campaign": {
"anyOf": [
{
"$ref": "#/$defs/CampaignDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "CreateCampaignOutput",
"type": "object"
}
patch_campaign — Update documented campaign fields.
patch_campaign — Update documented campaign fields.
Parameters
string
required
Campaign ID
string
Campaign name
object
Campaign schedule object with schedules array
array
Campaign sequence definitions
array
Sending email accounts
integer
Daily sending limit
integer
Daily maximum new leads to contact
boolean
Whether to track opens
boolean
Whether to stop the campaign on reply
boolean
Whether to track links
boolean
Whether the campaign is text only
integer
Gap between emails in minutes
number
Value of every positive lead
Response
{
"$defs": {
"CampaignDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"pl_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Pl Value"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"is_evergreen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Evergreen"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"email_gap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Gap"
},
"daily_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Limit"
},
"daily_max_leads": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Max Leads"
},
"open_tracking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Open Tracking"
},
"stop_on_reply": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Stop On Reply"
},
"sequences": {
"items": {},
"title": "Sequences",
"type": "array"
},
"campaign_schedule": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign Schedule"
}
},
"title": "CampaignDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"campaign": {
"anyOf": [
{
"$ref": "#/$defs/CampaignDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "PatchCampaignOutput",
"type": "object"
}
activate_campaign — Activate, start, or resume a campaign.
activate_campaign — Activate, start, or resume a campaign.
Parameters
string
required
Campaign ID
Response
{
"$defs": {
"CampaignDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"pl_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Pl Value"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"is_evergreen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Evergreen"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Updated"
},
"email_gap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Gap"
},
"daily_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Limit"
},
"daily_max_leads": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Daily Max Leads"
},
"open_tracking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Open Tracking"
},
"stop_on_reply": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Stop On Reply"
},
"sequences": {
"items": {},
"title": "Sequences",
"type": "array"
},
"campaign_schedule": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign Schedule"
}
},
"title": "CampaignDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"campaign": {
"anyOf": [
{
"$ref": "#/$defs/CampaignDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"success"
],
"title": "ActivateCampaignOutput",
"type": "object"
}
list_emails — Retrieve Unibox emails with search and pagination filters.
list_emails — Retrieve Unibox emails with search and pagination filters.
Parameters
integer
Number of emails to return, from 1 to 100
string
Pagination cursor from next_starting_after
string
Search query, email address, or thread:<thread-id>
string
Campaign ID filter
string
Lead list ID filter
integer
Email interest status filter
string
Sending email account filter
string
Lead email address filter
boolean
Unread status filter
Response
{
"$defs": {
"EmailBody": {
"additionalProperties": false,
"properties": {
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Text"
},
"html": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Html"
}
},
"title": "EmailBody",
"type": "object"
},
"EmailDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Email"
},
"message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message Id"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subject"
},
"from_address_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Address Email"
},
"to_address_email_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Address Email List"
},
"cc_address_email_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cc Address Email List"
},
"bcc_address_email_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bcc Address Email List"
},
"reply_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reply To"
},
"body": {
"anyOf": [
{
"$ref": "#/$defs/EmailBody"
},
{
"type": "null"
}
],
"default": null
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization Id"
},
"campaign_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign Id"
},
"subsequence_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subsequence Id"
},
"list_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "List Id"
},
"lead": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lead"
},
"lead_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lead Id"
},
"eaccount": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Eaccount"
},
"ue_type": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Ue Type"
},
"is_unread": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Unread"
},
"is_auto_reply": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Auto Reply"
},
"i_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "I Status"
},
"thread_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thread Id"
},
"content_preview": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Preview"
}
},
"title": "EmailDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"emails": {
"items": {
"$ref": "#/$defs/EmailDetail"
},
"title": "Emails",
"type": "array"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"next_starting_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Starting After"
}
},
"required": [
"success"
],
"title": "ListEmailsOutput",
"type": "object"
}
reply_to_email — Send a reply to an existing Unibox email.
reply_to_email — Send a reply to an existing Unibox email.
Parameters
string
required
Connected email account used to send the reply
string
required
Email ID to reply to
string
required
Reply subject
Reply body as plain text
string
Reply body as HTML
string
Comma-separated CC email addresses
string
Comma-separated BCC email addresses
Response
{
"$defs": {
"EmailBody": {
"additionalProperties": false,
"properties": {
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Text"
},
"html": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Html"
}
},
"title": "EmailBody",
"type": "object"
},
"EmailDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
},
"timestamp_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Email"
},
"message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message Id"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subject"
},
"from_address_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "From Address Email"
},
"to_address_email_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Address Email List"
},
"cc_address_email_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cc Address Email List"
},
"bcc_address_email_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bcc Address Email List"
},
"reply_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reply To"
},
"body": {
"anyOf": [
{
"$ref": "#/$defs/EmailBody"
},
{
"type": "null"
}
],
"default": null
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization Id"
},
"campaign_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Campaign Id"
},
"subsequence_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subsequence Id"
},
"list_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "List Id"
},
"lead": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lead"
},
"lead_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lead Id"
},
"eaccount": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Eaccount"
},
"ue_type": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Ue Type"
},
"is_unread": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Unread"
},
"is_auto_reply": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Auto Reply"
},
"i_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "I Status"
},
"thread_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thread Id"
},
"content_preview": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Preview"
}
},
"title": "EmailDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/EmailDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subject"
},
"thread_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thread Id"
}
},
"required": [
"success"
],
"title": "ReplyToEmailOutput",
"type": "object"
}
list_lead_lists — Retrieve lead lists with search and pagination filters.
list_lead_lists — Retrieve lead lists with search and pagination filters.
Parameters
integer
Number of lead lists to return, from 1 to 100
string
Starting-after cursor from next_starting_after
boolean
Filter by enrichment task setting
string
Search query to filter lead lists by name
Response
{
"$defs": {
"LeadListDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization Id"
},
"has_enrichment_task": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Enrichment Task"
},
"owned_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owned By"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
}
},
"title": "LeadListDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"lead_lists": {
"items": {
"$ref": "#/$defs/LeadListDetail"
},
"title": "Lead Lists",
"type": "array"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"next_starting_after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Starting After"
}
},
"required": [
"success"
],
"title": "ListLeadListsOutput",
"type": "object"
}
create_lead_list — Create a lead list.
create_lead_list — Create a lead list.
Parameters
string
required
Lead list name
boolean
Whether this list runs enrichment for every added lead
string
User ID of the lead list owner
Response
{
"$defs": {
"LeadListDetail": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Organization Id"
},
"has_enrichment_task": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Enrichment Task"
},
"owned_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Owned By"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"timestamp_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timestamp Created"
}
},
"title": "LeadListDetail",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"lead_list": {
"anyOf": [
{
"$ref": "#/$defs/LeadListDetail"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"success"
],
"title": "CreateLeadListOutput",
"type": "object"
}
Limits & Quotas
- List endpoints accept
limit(1–100) and forward-paginate via thenext_starting_aftercursor returned in each response — pass it back asstarting_afterfor the next page. update_lead_interest_statussubmits an asynchronous background job; the response carries a submissionmessage, not the updated lead.- Error model: non-2xx responses and timeouts are caught and
returned as
success=False+errorrather than raising. Plan agent retries based on the error string.