Skip to content

LeadLeadList

LeadLeadList objects are the connection from leads to lead-lists. Newsletter and raffle signups are examples of lead-lists. The status of the lead in the list can change after the initial creation of the junction between the lead and the lead list based on the status of consents that the individual lead has granted or grants over time (as in mail based consents like douple opt-ins).

Structure

id: string

Unique identifier for the LeadList.

name: string

Custom name of the LeadList.

status: "is_signed_up" | "is_verified" | "is_unlisted"

Status of the LeadLeadList junction. Indicates whether the lead in the list is signed up, verified, or unlisted.

meta: object

Meta Object

Example Object

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Main Newsletter",
  "status": "is_signed_up",
  "meta": {
    "key": "value"
  }
}