Skip to content

Leads

The lead object

On this page

Attributes

attempt_countintegerMay be absent

Default 0

callsarray of object or nullMay be absent
Every attempt, newest last. On GET /leads/{id} and POST responses.
calls_urlstringAlways present
created_atstring (date-time)Always present
current_dispositionstringAlways present
dedup_statusstring or nullMay be absent
dial_blockerstring or nullMay be absent
disposition_atstring (date-time) or nullMay be absent
emailstring or nullMay be absent
external_idstring or nullMay be absent
first_namestring or nullMay be absent
idstringAlways present
is_dncbooleanMay be absent

Default false

is_testbooleanMay be absent

Default false

jornaya_leadidstring or nullMay be absent
last_attempted_atstring (date-time) or nullMay be absent
last_namestring or nullMay be absent
metadataobjectMay be absent
Free-form key and value pairs.
national_dnc_statusstring or nullMay be absent
next_attempt_atstring (date-time) or nullMay be absent
organization_idstringAlways present
pause_is_queuedbooleanMay be absent

Default false

pausedbooleanMay be absent

Default false

paused_atstring (date-time) or nullMay be absent
paused_reasonstring or nullMay be absent
phonestringAlways present
phone_altstring or nullMay be absent
preferred_languagestring or nullMay be absent
replayedboolean or nullMay be absent
On POST responses: true on a 200 replay.
sequence_statusstring or nullMay be absent
sequence_stepintegerMay be absent

Default 0

statestring or nullMay be absent
status_urlstringAlways present
timezonestring or nullMay be absent
transfer_phonestring or nullMay be absent
Always null for now.
trustedform_cert_urlstring or nullMay be absent
updated_atstring (date-time)Always present
zip_codestring or nullMay be absent

Returned by