ExternalLead

Stentor API Reference

---

Stentor API Reference / stentor-models/src / ExternalLead

Interface: ExternalLead

Defined in: packages/stentor-models/src/Crm.ts:9

Properties

userId?

optional userId?: string

Defined in: packages/stentor-models/src/Crm.ts:13

The user ID that generated the lead

---

sessionId?

optional sessionId?: string

Defined in: packages/stentor-models/src/Crm.ts:17

The session ID that generated the lead

---

fields

fields: LeadFormField[]

Defined in: packages/stentor-models/src/Crm.ts:21

Fields such as name and email

---

source?

optional source?: string

Defined in: packages/stentor-models/src/Crm.ts:25

Optional source, typically chat-widget or form-widget

---

company?

optional company?: string

Defined in: packages/stentor-models/src/Crm.ts:29

Optional company

---

transcript?

optional transcript?: Message[]

Defined in: packages/stentor-models/src/Crm.ts:34

Transcript of the conversation

---

refId?

optional refId?: string

Defined in: packages/stentor-models/src/Crm.ts:38

Optional reference ID in the 3rd party CRM or FSM

---

jobTypeId?

optional jobTypeId?: string

Defined in: packages/stentor-models/src/Crm.ts:43

Optional job type ID in the 3rd party CRM (this maybe looked up already as a side effect of the avalability request)

---

availabilityClassId?

optional availabilityClassId?: string

Defined in: packages/stentor-models/src/Crm.ts:47

Optinal id to to identify the availabilty stratego (blocked days ahead, etc)

---

isAbandoned?

optional isAbandoned?: boolean

Defined in: packages/stentor-models/src/Crm.ts:51

Is it abandoned (unfinished)?

---

placeId?

optional placeId?: string

Defined in: packages/stentor-models/src/Crm.ts:57

Optional Google Place ID identifying which business location this lead originated from. Used for multi-location businesses to route leads to the correct external system.