PATCH
/
leadEvents

Authorizations

​
Authorization
string
headerrequired

Query Parameters

​
sort
string

sort by field

​
where
object
required

pass a where query to constrain returned documents (complex type, see documentation)

​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
lead
​
type
enum<string> | null
Available options:
Cancel,
Customer Answered,
Customer Call,
Customer DNC Request,
Customer Email,
Customer Needs More Options,
Customer Search Provided,
Customer Selects Vehicle,
Customer Text,
Lead Created,
Loan Service Redirect,
Outbound Email,
Outbound Phone Call,
Outbound Phone Call Answered,
Outbound Phone Call Not Answered,
Outbound Text,
Outbound Voicemail Left,
Scheduled Call,
Search Results Found,
Status Check,
Time Passed
​
status
enum<string> | null
Available options:
Provide Customer With Three Options,
Customer Provided Options,
Answer Text Message,
Had Conversation,
Intake Form Submitted,
Send Text Message,
Send Text Template 1,
Waiting For Meeting,
Call Customer,
First Communication Attempt,
First Communication Attempt (phone and text),
Searching,
Second Communication Attempt,
Send Text Nudge 1,
Waiting For Email Response,
Looking For Financing,
Customer Not Interested,
No Contact,
Customer Not Responding,
Customer Interested
​
nextSteps
string | null
​
createdBy
number
​
currentStatusFor

Response

200 - application/json
​
message
string
​
errors
string[]
​
docs
object[]
Delete multiple Lead EventsGet a single Lead Event by its id