PATCH
/
searches
curl --request PATCH \
  --url https://commerce.driv.ly/api/searches \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lead": 123,
  "status": "On Hold",
  "retailListingUrls": "<string>",
  "year": "<string>",
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "bodyStyle": [
    "car"
  ],
  "drive": [
    "4WD"
  ],
  "transmission": [
    "Manual"
  ],
  "maxPrice": "<string>",
  "maxMiles": 123,
  "newOrUsed": [
    "New"
  ],
  "minimumGrade": 123,
  "requiredOptions": [
    "Heated Seats"
  ],
  "acceptableColors": [
    "Anti-Black"
  ],
  "acceptableInterior": [
    "Beige"
  ],
  "proposedVehicles": "<string>",
  "vehicles": [
    123
  ],
  "lastModifiedBy": 123,
  "seats": "<string>",
  "updateRequested": "<string>",
  "oneOwner": true,
  "priority": true,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'
{
  "message": "<string>",
  "errors": [
    "<string>"
  ],
  "docs": [
    {
      "lead": 123,
      "status": "On Hold",
      "retailListingUrls": "<string>",
      "year": "<string>",
      "make": "<string>",
      "model": "<string>",
      "trim": "<string>",
      "bodyStyle": [
        "car"
      ],
      "drive": [
        "4WD"
      ],
      "transmission": [
        "Manual"
      ],
      "maxPrice": "<string>",
      "maxMiles": 123,
      "newOrUsed": [
        "New"
      ],
      "minimumGrade": 123,
      "requiredOptions": [
        "Heated Seats"
      ],
      "acceptableColors": [
        "Anti-Black"
      ],
      "acceptableInterior": [
        "Beige"
      ],
      "proposedVehicles": "<string>",
      "vehicles": [
        123
      ],
      "lastModifiedBy": 123,
      "seats": "<string>",
      "updateRequested": "<string>",
      "oneOwner": true,
      "priority": true,
      "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.