Skip to main content
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>"
}
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

​
id
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

ok

​
doc
LeadEvent · object
required
​
message
string
required