Skip to content

Lead

A Lead represents an individual who has shown interest in our services. This document outlines the structure and example data for a Lead.

Structure

id: string

Unique identifier for the Lead.

email: string

Email address of the Lead.

lists: LeadLeadList[]

List of LeadList connections. See LeadLeadList Object.

personal_data: object

Personal information of the Lead. - email: string
Email address of the Lead. - key: string | number
Additional personal data.

consents: LeadConsent[]

List of consent-lead connections. See LeadConsent Object.

meta: Meta

Metadata associated with the Lead. See Meta Object.

delete_lead_url: string | null

Unauthenticated api url to trigger a lead deletion. This url can either be used by the lead directly (e.g. via their mail client) to delete their data or by an external system to delete the data for the lead.

If a lead deletion request has been triggered already the url will be set to null.

Example Data

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "example@example.com",
  "lists": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Main Newsletter",
      "status": "is_signed_up",
      "meta": {
        "resource-name": "newsletter-1"
      }
    },
    {
      "id": "223e4567-e89b-12d3-a456-426614174000",
      "name": "Raffle",
      "status": "is_verified",
      "meta": {
        "resource-name": "main-raffle"
      }
    }
  ],
  "personal_data": {
    "email": "example@example.com",
    "salutation": "Herr",
    "title": "Dr.",
    "first_name": "Max",
    "last_name": "Mustermann",
    "birthdate": "1968-04-19",
    "phone": "+49 030 3994744",
    "mobile": "+49 0178 0178 0178",
    "address_line_1": "Feldmarkweg 50",
    "city": "Berlin",
    "country": "deutschland",
  },
  "consents": [
    {
      "id": "string",
      "type": "checkbox",
      "name": "Newsletter Wanted",
      "status": "active",

      "meta": {
        "key": "value"
      }
    },
    {
      "id": "string",
      "type": "external",
      "name": "Newsletter Double Opt-In",
      "status": "requested",

      "meta": {
        "key": "value"
      }
    }
  ],
  "meta": {
    "campaign_id": "1234abcd"
  },
  "delete_lead_url": "https://scanly.net/[...]"
}