PATCH
/
leadEvents
/
{id}
curl --request PATCH \
  --url https://commerce.driv.ly/api/leadEvents/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lead": 123,
  "type": "Cancel",
  "status": "Provide Customer With Three Options",
  "nextSteps": "<string>",
  "createdBy": 123,
  "currentStatusFor": 123,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'
{
  "doc": {
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123,
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

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

Body

application/json

Response

200
application/json

ok

The response is of type object.