PATCH
/
leadEvents
curl --request PATCH \
  --url https://commerce.driv.ly/api/leadEvents \
  --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>"
}'
{
  "message": "<string>",
  "errors": [
    "<string>"
  ],
  "docs": [
    {
      "lead": 123,
      "type": "Cancel",
      "status": "Provide Customer With Three Options",
      "nextSteps": "<string>",
      "createdBy": 123,
      "currentStatusFor": 123,
      "updatedAt": "<string>",
      "createdAt": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
sort
string

sort by field

​
where
object
required

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

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
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

Response

200 - application/json

ok

The response is of type object.