Move leads to a campaign or list

A lead entity representing an individual lead

idstring(uuid)read-onlyrequired

Unique identifier for the lead

Example: "0196cc61-c0eb-7da8-8660-50c4382d41f1"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead was created

Example: "2025-05-14T01:21:20.619Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the lead was last updated

Example: "2025-05-14T01:21:20.619Z"

organizationstring(uuid)read-onlyrequired

Organization ID associated with the lead

Example: "0196cc61-c0eb-7da8-8660-50c54b6c194b"

statusnumberread-onlyrequired

Status of the lead

Enum Value	Description
1	Active
2	Paused
3	Completed
-1	Bounced
-2	Unsubscribed
-3	Skipped
x-parsed-md-1	Active
x-parsed-md-2	Paused
x-parsed-md-3	Completed
x-parsed-md--1	Bounced

Example: 1

email_open_countnumberread-onlyrequired

Number of times the email was opened

Example: 0

email_reply_countnumberread-onlyrequired

Number of times the email was replied to

Example: 0

email_click_countnumberread-onlyrequired

Number of times the email was clicked

Example: 0

company_domainstringread-onlyrequired

Company domain of the lead

Example: "example.com"

status_summaryobjectread-onlyrequired

Status summary of the lead

status_summary.fromstring

Example: "campaign"

status_summary.stepIDstring

Example: "0196cc61-c0eb-7da8-8660-50c72c0c9fc2"

status_summary.timestamp_executedstring(date-time)

Example: "2025-05-14T01:21:20.619Z"

campaignstring(uuid)

Campaign ID associated with the lead

Example: "0196cc61-c0eb-7da8-8660-50c6adaabfac"

emailstring

Email address of the lead

Example: "example@example.com"

personalizationstring

Personalization of the lead

Example: "Hello, how are you?"

websitestring

Website of the lead

Example: "https://example.com"

last_namestring

Last name of the lead

Example: "Doe"

first_namestring

First name of the lead

Example: "John"

company_namestring

Company name of the lead

Example: "Example Inc."

phonestring

Phone number of the lead

Example: "+1234567890"

payloadobjectread-only

Lead custom variables. This object can contain any key, but the values have to be of type string, number, boolean, or null. We do NOT allow objects or arrays as values.

status_summary_subseqobjectread-only

Subsequence status summary of the lead

last_step_fromstringread-only

Source of the last step

Example: "campaign"

last_step_idstring(uuid)read-only

ID of the last step

Example: "0196cc61-c0eb-7da8-8660-50c95e2d5743"

last_step_timestamp_executedstring(date-time)read-only

Timestamp when the last step was executed

Example: "2025-05-14T01:21:20.619Z"

email_opened_stepnumberread-only

Last email step opened by the lead

Example: 1

email_opened_variantnumberread-only

Last step variant opened by the lead

Example: 1

email_replied_stepnumberread-only

Last email step the lead has replied to

Example: 1

email_replied_variantnumberread-only

Last step variant the lead has replied to

Example: 1

email_clicked_stepnumberread-only

Last email step the lead has clicked

Example: 1

email_clicked_variantnumberread-only

Last step variant the lead has clicked

Example: 1

lt_interest_statusnumber

Lead interest status. It can be either a static value (check below), or a custom status interest value

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
x-parsed-md-0	Out of Office
x-parsed-md-1	Interested

Example: 1

subsequence_idstringread-only

ID of the subsequence

Example: "0196cc61-c0eb-7da8-8660-50cad066397f"

verification_statusnumberread-only

Verification status of the lead

Enum Value	Description
1	Verified
11	Pending
12	Pending Verification Job
-1	Invalid
-2	Risky
-3	Catch All
-4	Job Change
x-parsed-md-1	Verified
x-parsed-md-11	Pending
x-parsed-md-12	Pending Verification Job

Example: 1

pl_value_leadstring

Potential value of the lead

Example: "High"

timestamp_added_subsequencestring(date-time)read-only

Timestamp when the lead was added to the subsequence

Example: "2025-05-14T01:21:20.619Z"

timestamp_last_contactstring(date-time)read-only

Timestamp of the last contact with the lead

Example: "2025-05-14T01:21:20.619Z"

timestamp_last_openstring(date-time)read-only

Timestamp of the last email open

Example: "2025-05-14T01:21:20.619Z"

timestamp_last_replystring(date-time)read-only

Timestamp of the last email reply

Example: "2025-05-14T01:21:20.619Z"

timestamp_last_interest_changestring(date-time)read-only

Timestamp of the last interest status change

Example: "2025-05-14T01:21:20.619Z"

timestamp_last_clickstring(date-time)read-only

Timestamp of the last email click

Example: "2025-05-14T01:21:20.619Z"

enrichment_statusnumberread-only

Enrichment status of the lead

Enum Value	Description
1	Enriched
11	Pending
-1	Enrichment data not available
-2	Error
x-parsed-md-1	Enriched
x-parsed-md-11	Pending
x-parsed-md--1	Enrichment data not available
x-parsed-md--2	Error

Example: 1

list_idstring(uuid)

List ID associated with the lead

Example: "0196cc61-c0eb-7da8-8660-50cb21da07f0"

last_contacted_fromstringread-only

Source of the last contact

Example: "email"

uploaded_by_userstring(uuid)read-only

ID of the user who uploaded the lead

Example: "0196cc61-c0eb-7da8-8660-50ccb3b14cca"

upload_methodstringread-only

Method used to upload the lead

Enum Value	Description
manual	Manual
api	API
website-visitor	Website Visitor
x-parsed-md-manual	Manual
x-parsed-md-api	API
x-parsed-md-website-visitor	Website Visitor

Example: "manual"

assigned_tostring(uuid)

ID of the user assigned to the lead

Example: "0196cc61-c0eb-7da8-8660-50cd2aa41ad8"

is_website_visitorbooleanread-only

Indicates if the lead is a website visitor

Example: true

timestamp_last_touchstring(date-time)read-only

Timestamp of the last touch with the lead

Example: "2025-05-14T01:21:20.619Z"

esp_codenumberread-only

ESP code associated with the lead

Enum Value	Description
0	In Queue
1	Google
2	Microsoft
3	Zoho
9	Yahoo
10	Yandex
12	Web.de
13	Libero.it
999	Other
1000	Not Found

Example: 1

{
  "id": "0196cc61-c0eb-7da8-8660-50c4382d41f1",
  "timestamp_created": "2025-05-14T01:21:20.619Z",
  "timestamp_updated": "2025-05-14T01:21:20.619Z",
  "organization": "0196cc61-c0eb-7da8-8660-50c54b6c194b",
  "campaign": "0196cc61-c0eb-7da8-8660-50c6adaabfac",
  "status": 1,
  "email": "example@example.com",
  "personalization": "Hello, how are you?",
  "website": "https://example.com",
  "last_name": "Doe",
  "first_name": "John",
  "company_name": "Example Inc.",
  "phone": "+1234567890",
  "email_open_count": 0,
  "email_reply_count": 0,
  "email_click_count": 0,
  "company_domain": "example.com",
  "status_summary": {
    "from": "campaign",
    "stepID": "0196cc61-c0eb-7da8-8660-50c72c0c9fc2",
    "timestamp_executed": "2025-05-14T01:21:20.619Z"
  },
  "payload": {
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Corp",
    "website": "https://example.com",
    "phone": "+1234567890",
    "personalization": "Hi {{first_name}}, I noticed you work at {{company_name}}...",
    "property1": null,
    "property2": null
  },
  "status_summary_subseq": {
    "from": "campaign",
    "stepID": "0196cc61-c0eb-7da8-8660-50c869f26b46",
    "timestampExecuted": "2025-05-14T01:21:20.619Z"
  },
  "last_step_from": "campaign",
  "last_step_id": "0196cc61-c0eb-7da8-8660-50c95e2d5743",
  "last_step_timestamp_executed": "2025-05-14T01:21:20.619Z",
  "email_opened_step": 1,
  "email_opened_variant": 1,
  "email_replied_step": 1,
  "email_replied_variant": 1,
  "email_clicked_step": 1,
  "email_clicked_variant": 1,
  "lt_interest_status": 1,
  "subsequence_id": "0196cc61-c0eb-7da8-8660-50cad066397f",
  "verification_status": 1,
  "pl_value_lead": "High",
  "timestamp_added_subsequence": "2025-05-14T01:21:20.619Z",
  "timestamp_last_contact": "2025-05-14T01:21:20.619Z",
  "timestamp_last_open": "2025-05-14T01:21:20.619Z",
  "timestamp_last_reply": "2025-05-14T01:21:20.619Z",
  "timestamp_last_interest_change": "2025-05-14T01:21:20.619Z",
  "timestamp_last_click": "2025-05-14T01:21:20.619Z",
  "enrichment_status": 1,
  "list_id": "0196cc61-c0eb-7da8-8660-50cb21da07f0",
  "last_contacted_from": "email",
  "uploaded_by_user": "0196cc61-c0eb-7da8-8660-50ccb3b14cca",
  "upload_method": "manual",
  "assigned_to": "0196cc61-c0eb-7da8-8660-50cd2aa41ad8",
  "is_website_visitor": true,
  "timestamp_last_touch": "2025-05-14T01:21:20.619Z",
  "esp_code": 1
}

Enum Value	Description
FILTER_VAL_CONTACTED	Filter for contacted leads
FILTER_VAL_NOT_CONTACTED	Filter for not contacted leads
FILTER_VAL_COMPLETED	Filter for completed leads
FILTER_VAL_UNSUBSCRIBED	Filter for unsubscribed leads
FILTER_VAL_ACTIVE	Filter for active leads
FILTER_LEAD_INTERESTED	Filter for interested leads
FILTER_LEAD_NOT_INTERESTED	Filter for not interested leads
FILTER_LEAD_MEETING_BOOKED	Filter for leads with meeting booked
FILTER_LEAD_MEETING_COMPLETED	Filter for leads with meeting completed
FILTER_LEAD_CLOSED	Filter for closed leads

Enum Value	Description
1	The lead has been successfully enriched
11	The lead is pending enrichment
-1	Enrichment data is not available for the lead
-2	An error occurred during the enrichment process
x-parsed-md-1	The lead has been successfully enriched
x-parsed-md-11	The lead is pending enrichment
x-parsed-md--1	Enrichment data is not available for the lead
x-parsed-md--2	An error occurred during the enrichment process

Enum Value	Description
move-leads	Move Leads
import-leads	Import Leads
export-leads	Export Leads
x-parsed-md-move-leads	Move Leads
x-parsed-md-import-leads	Import Leads
x-parsed-md-export-leads	Export Leads

Enum Value	Description
pending	The background job is waiting in the queue to be processed
in-progress	The background job is being processed
success	The background job has been successfully processed
failed	The background job has failed
x-parsed-md-pending	The background job is waiting in the queue to be processed
x-parsed-md-in-progress	The background job is being processed
x-parsed-md-success	The background job has been successfully processed
x-parsed-md-failed	The background job has failed

Enum Value	Description
list	The entity is a lead list
campaign	The entity is a campaign
x-parsed-md-list	The entity is a lead list
x-parsed-md-campaign	The entity is a campaign

API Explorer (2.0.0)

Analytics

Account

Campaign

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Lead

Create lead

RequestExpand all

Responses

Was this helpful?

List leads

RequestExpand all

Responses

Was this helpful?

Get lead

Request

Responses

Was this helpful?

Patch lead

RequestExpand all

Responses

Was this helpful?

Delete lead

Request

Responses

Was this helpful?

Merge two leads

Request

Responses

Was this helpful?

Update the interest status of a lead

Request

Responses

Was this helpful?

Remove a lead from a subsequence

Request

Responses

Was this helpful?

Bulk assign leads to organization users

RequestExpand all

Responses

Was this helpful?