curl --request POST \
  --url https://api.trysela.com/api/leads/ \
  --header 'Authorization: Token <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "first_name@trysela.com",
    "phone_number": "+18042221111",
    "metadata": {
      "first_name": "First",
      "last_name": "Name",
      "timezone": "America/Los_Angeles",
      "property_address": "123 Main St",
      "property_city": "San Francisco",
      "property_state": "California",
      "property_zip": "94101",
      "address": "456 2nd St",
      "city": "Los Angeles",
      "state": "California",
      "zip": "90001"
    },
    "external_id": "id_in_your_crm_123",
    "lead_source": "USDALoans.com",
    "lead_type": 123,
    "representative": 456,
    "us_state": "CA"
  }'

{
  "id": 28013,
  "email": "first_name@trysela.com",
  "phone_number": "+18042221111",
  "metadata": {
    "phone_number": "+18042221111",
    "email": "first_name@trysela.com",
    "first_name": "First",
    "last_name": "Name",
    "timezone": "America/Los_Angeles",
    "created_at": "02/28/2025 15:09",
    "property_address": "123 Main St",
    "property_city": "San Francisco",
    "property_state": "California",
    "property_zip": "94101",
    "address": "456 2nd St",
    "city": "Los Angeles",
    "state": "California",
    "zip": "90001",
    "lead_source": "USDALoans.com",
    "external_id": "id_in_your_crm_123"
  },
  "modified_time": "2025-02-28T15:09:03.139554-08:00",
  "created_time": "2025-02-28T15:09:03.122515-08:00",
  "status": "OPEN",
  "status_reason": null,
  "lead_source": "USDALoans.com",
  "lead_type": 123,
  "representative": 456,
  "next_call_time": "2025-02-28T15:09:03.122515-08:00",
  "next_call_time_reason": "FIRST_CALL",
  "external_id": "id_in_your_crm_123",
  "us_state": "CA",
  "received_time": "2025-02-28T15:09:03.122515-08:00",
  "reengagements_count": 1,
  "last_reengagement_time": null,
  "call_schedule_start_time": null,
  "sms_dnc": false,
  "call_dnc": false
}

Leads

Create a Lead

Creates a lead for the authenticated API user. phone_number is required; email, lead_type, external_id, and metadata are optional. Use GET /api/lead-types/ to discover available lead type IDs and their public metadata fields. Unknown top-level fields are preserved in metadata, which lets customer-specific values be used by the agent. If reengagement is configured and the payload matches an eligible existing lead, that lead is reengaged and returned with a 200 response instead of creating a duplicate.

POST

api

leads

curl --request POST \
  --url https://api.trysela.com/api/leads/ \
  --header 'Authorization: Token <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "first_name@trysela.com",
    "phone_number": "+18042221111",
    "metadata": {
      "first_name": "First",
      "last_name": "Name",
      "timezone": "America/Los_Angeles",
      "property_address": "123 Main St",
      "property_city": "San Francisco",
      "property_state": "California",
      "property_zip": "94101",
      "address": "456 2nd St",
      "city": "Los Angeles",
      "state": "California",
      "zip": "90001"
    },
    "external_id": "id_in_your_crm_123",
    "lead_source": "USDALoans.com",
    "lead_type": 123,
    "representative": 456,
    "us_state": "CA"
  }'

{
  "id": 28013,
  "email": "first_name@trysela.com",
  "phone_number": "+18042221111",
  "metadata": {
    "phone_number": "+18042221111",
    "email": "first_name@trysela.com",
    "first_name": "First",
    "last_name": "Name",
    "timezone": "America/Los_Angeles",
    "created_at": "02/28/2025 15:09",
    "property_address": "123 Main St",
    "property_city": "San Francisco",
    "property_state": "California",
    "property_zip": "94101",
    "address": "456 2nd St",
    "city": "Los Angeles",
    "state": "California",
    "zip": "90001",
    "lead_source": "USDALoans.com",
    "external_id": "id_in_your_crm_123"
  },
  "modified_time": "2025-02-28T15:09:03.139554-08:00",
  "created_time": "2025-02-28T15:09:03.122515-08:00",
  "status": "OPEN",
  "status_reason": null,
  "lead_source": "USDALoans.com",
  "lead_type": 123,
  "representative": 456,
  "next_call_time": "2025-02-28T15:09:03.122515-08:00",
  "next_call_time_reason": "FIRST_CALL",
  "external_id": "id_in_your_crm_123",
  "us_state": "CA",
  "received_time": "2025-02-28T15:09:03.122515-08:00",
  "reengagements_count": 1,
  "last_reengagement_time": null,
  "call_schedule_start_time": null,
  "sms_dnc": false,
  "call_dnc": false
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Body

Describe fields accepted when creating a lead.

This serializer is documentation-only and must not be used for deserialization. min_reengagement_days is not a Lead model field and would otherwise reach ModelSerializer.create() as an unknown keyword argument.

phone_number

string

required

The phone number of the lead. Either E.164 or US format. Must have a valid area code.

Minimum string length: 1

string<email> | null

The email address of the lead.

metadata

object | null

Any additional information associated with the lead as json metadata. Any of the values supplied here can be used by the agent in the talk track. Any additional payload fields that are not part of the standard lead fields will be automatically stored in the metadata upon lead creation or update, so lead metadata can also be sent as additional keys in the payload. Common fields to include in the metadata are first_name and last_name.

status

enum<string>

The status of the lead. This is updated automatically.

UNKNOWN - Unknown
NEW - New
OPEN - Open
CALLBACK_TO_TRANSFER - Callback to transfer
CLOSED - Closed
CLOSED_INCOMPLETE - Closed incomplete
LOST - Lost
SCHEDULE_COMPLETED - Schedule completed
OUT_OF_TERRITORY - Out of territory
BAD_NUMBER - Bad number
CANCELLED - Cancelled

Available options:

UNKNOWN,

NEW,

OPEN,

CALLBACK_TO_TRANSFER,

CLOSED,

CLOSED_INCOMPLETE,

LOST,

SCHEDULE_COMPLETED,

OUT_OF_TERRITORY,

BAD_NUMBER,

CANCELLED

lead_type

integer | null

The id of the campaign this lead is a part of.

representative

integer | null

The id of the representative assigned to this lead.

external_id

string | null

The external id of the lead. This can be your CRM id.

Maximum string length: 255

us_state

The US state of the lead. This is used to determine the timezone of the lead, as well as for compliance with telemarketing regulations.

AL - Alabama
AK - Alaska
AS - American Samoa
AZ - Arizona
AR - Arkansas
AA - Armed Forces Americas
AE - Armed Forces Europe
AP - Armed Forces Pacific
CA - California
CO - Colorado
CT - Connecticut
DE - Delaware
DC - District of Columbia
FL - Florida
GA - Georgia
GU - Guam
HI - Hawaii
ID - Idaho
IL - Illinois
IN - Indiana
IA - Iowa
KS - Kansas
KY - Kentucky
LA - Louisiana
ME - Maine
MD - Maryland
MA - Massachusetts
MI - Michigan
MN - Minnesota
MS - Mississippi
MO - Missouri
MT - Montana
NE - Nebraska
NV - Nevada
NH - New Hampshire
NJ - New Jersey
NM - New Mexico
NY - New York
NC - North Carolina
ND - North Dakota
MP - Northern Mariana Islands
OH - Ohio
OK - Oklahoma
OR - Oregon
PA - Pennsylvania
PR - Puerto Rico
RI - Rhode Island
SC - South Carolina
SD - South Dakota
TN - Tennessee
TX - Texas
UT - Utah
VT - Vermont
VI - Virgin Islands
VA - Virginia
WA - Washington
WV - West Virginia
WI - Wisconsin
WY - Wyoming

Available options:

AL,

AK,

AS,

AZ,

AR,

AA,

AE,

AP,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

GU,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

MP,

OH,

OK,

OR,

PA,

PR,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VI,

VA,

WA,

WV,

WI,

WY

lead_source

string | null

The source of the lead. This can be used to track the lead provider.

Maximum string length: 255

call_schedule_start_time

string<date-time> | null

min_reengagement_days

integer | null

Minimum number of days since creation or the last reengagement before a matching existing lead may be reopened. Omit to use the lead type default.

Required range: x >= 0

Response

An eligible existing lead was reengaged.

integer

required

read-only

phone_number

string

required

The phone number of the lead. Either E.164 or US format. Must have a valid area code.

modified_time

string<date-time>

required

read-only

The last time this lead was modified.

created_time

string<date-time>

required

read-only

The time this lead was created.

next_call_time

string | null

required

read-only

The time of the next call scheduled for this lead.

next_call_time_reason

string | null

required

read-only

The reasons for the next call scheduled time for this lead.

received_time

string<date-time> | null

required

read-only

The time this lead was received by an API call.

reengagements_count

integer

required

read-only

The total number of times this lead has been reengaged.

last_reengagement_time

string<date-time> | null

required

read-only

The time this lead was last reengaged.

sms_dnc

boolean | null

required

read-only

If True, the lead has been marked as do not contact for the SMS channel (DNC).

call_dnc

boolean | null

required

read-only

If True, the lead has been marked as do not contact for the call channel (DNC).

string<email> | null

The email address of the lead.

metadata

object | null

status

enum<string>

The status of the lead. This is updated automatically.

UNKNOWN - Unknown
NEW - New
OPEN - Open
CALLBACK_TO_TRANSFER - Callback to transfer
CLOSED - Closed
CLOSED_INCOMPLETE - Closed incomplete
LOST - Lost
SCHEDULE_COMPLETED - Schedule completed
OUT_OF_TERRITORY - Out of territory
BAD_NUMBER - Bad number
CANCELLED - Cancelled

Available options:

UNKNOWN,

NEW,

OPEN,

CALLBACK_TO_TRANSFER,

CLOSED,

CLOSED_INCOMPLETE,

LOST,

SCHEDULE_COMPLETED,

OUT_OF_TERRITORY,

BAD_NUMBER,

CANCELLED

status_detail

Sub-type of the status outcome (e.g. blind_transfer, warm_transfer, appointment_booked). This is updated automatically.

blind_transfer - Blind transfer
warm_transfer - Warm transfer
appointment_booked - Appointment booked
live_handoff_unavailable - Live handoff unavailable
escalation - Escalation
has_call_dnc - Has call DNC
tcpa_litigator - TCPA litigator
LEAD_ASSIGNED - Lead assigned
application_link_sms - Application link SMS

Available options:

blind_transfer,

warm_transfer,

appointment_booked,

live_handoff_unavailable,

escalation,

has_call_dnc,

tcpa_litigator,

LEAD_ASSIGNED,

application_link_sms

status_reason

The reason for the current status of the lead. This is updated automatically.

UNKNOWN - Unknown
WEBHOOK - Webhook
MANUAL - Manual
CHAT - Chat
REENGAGEMENT - Reengagement

Available options:

UNKNOWN,

WEBHOOK,

MANUAL,

CHAT,

REENGAGEMENT

lead_type

integer | null

The id of the campaign this lead is a part of.

representative

integer | null

The id of the representative assigned to this lead.

external_id

string | null

The external id of the lead. This can be your CRM id.

Maximum string length: 255

us_state

The US state of the lead. This is used to determine the timezone of the lead, as well as for compliance with telemarketing regulations.

AL - Alabama
AK - Alaska
AS - American Samoa
AZ - Arizona
AR - Arkansas
AA - Armed Forces Americas
AE - Armed Forces Europe
AP - Armed Forces Pacific
CA - California
CO - Colorado
CT - Connecticut
DE - Delaware
DC - District of Columbia
FL - Florida
GA - Georgia
GU - Guam
HI - Hawaii
ID - Idaho
IL - Illinois
IN - Indiana
IA - Iowa
KS - Kansas
KY - Kentucky
LA - Louisiana
ME - Maine
MD - Maryland
MA - Massachusetts
MI - Michigan
MN - Minnesota
MS - Mississippi
MO - Missouri
MT - Montana
NE - Nebraska
NV - Nevada
NH - New Hampshire
NJ - New Jersey
NM - New Mexico
NY - New York
NC - North Carolina
ND - North Dakota
MP - Northern Mariana Islands
OH - Ohio
OK - Oklahoma
OR - Oregon
PA - Pennsylvania
PR - Puerto Rico
RI - Rhode Island
SC - South Carolina
SD - South Dakota
TN - Tennessee
TX - Texas
UT - Utah
VT - Vermont
VI - Virgin Islands
VA - Virginia
WA - Washington
WV - West Virginia
WI - Wisconsin
WY - Wyoming

Available options:

AL,

AK,

AS,

AZ,

AR,

AA,

AE,

AP,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

GU,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

MP,

OH,

OK,

OR,

PA,

PR,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VI,

VA,

WA,

WV,

WI,

WY

lead_source

string | null

The source of the lead. This can be used to track the lead provider.

Maximum string length: 255

call_schedule_start_time

string<date-time> | null

List Leads Bulk Create Leads

API Documentation

Leads

Call Control

Lead Types

Webhooks

Lead Ingestion

File Ingestion

Create a Lead

Authorizations

Body

Response