Deletes an existing Lead Event

curl --request DELETE \
  --url https://commerce.driv.ly/api/leadEvents/{id} \
  --header 'Authorization: <api-key>'

{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123
  },
  "message": "<string>"
}

DELETE

leadEvents

{id}

Deletes an existing Lead Event

curl --request DELETE \
  --url https://commerce.driv.ly/api/leadEvents/{id} \
  --header 'Authorization: <api-key>'

{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123
  },
  "message": "<string>"
}

Usage with the Drivly SDK

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { leadEvents } from '@drivly/commerce'

const sdk = new SDK(...)

const leadEvents = await sdk.leadEvents.delete(leadEventsId: string): Promise<void>

Authorizations

Authorization

string

header

required

Path Parameters

string

required

id of the Lead Event

Query Parameters

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

Response

doc

LeadEvent · object

required

Show child attributes

doc.updatedAt

string

required

doc.createdAt

string

required

doc.lead

number | null

doc.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

doc.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

doc.nextSteps

string | null

doc.createdBy

number | null

doc.currentStatusFor

number | null

message

string

required

Get a single Lead Event by its id Updates a Lead Event

⌘I

Commerce

Resources

API Reference

Deletes an existing Lead Event

Authorizations

Path Parameters

Query Parameters

Response