CampaignLead

A lead in a campaign. `email` is the identity and dedup key — re-adding the same address updates it.

Properties

idstring

Lead ID, derived deterministically from the email address

emailstring

Lead email address

namestring

Lead name

statusstring

`added` (awaiting enrolment), `in_sequence` (running), then a terminal state: `completed`, `replied`, `responded`, `bounced`, `unsubscribed`, `suppressed`, `removed`.

"added""in_sequence""completed""removed""replied""responded""unsubscribed""suppressed""bounced"

email_providerstring (nullable)

Mail provider derived from the address's MX records, e.g. `google`, `microsoft`, `unknown`

fieldsobject

Custom field values, keyed by field name from the campaign's `lead_schema`

current_node_idstring (nullable)

Sequence node the lead is currently at

next_run_atstring <date-time> (nullable)

When the lead's next step is due

replied_atstring <date-time> (nullable)

created_atstring <date-time>

Example

CampaignLead example

{
  "id": "string",
  "email": "string",
  "name": "string",
  "status": "added",
  "email_provider": "string",
  "fields": {},
  "current_node_id": "string",
  "next_run_at": "1970-01-01T00:00:00.000Z",
  "replied_at": "1970-01-01T00:00:00.000Z",
  "created_at": "1970-01-01T00:00:00.000Z"
}