PATCH
/
searches
/
{id}
curl --request PATCH \
  --url https://commerce.driv.ly/api/searches/{id} \
  --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>"
}'
{
  "doc": {
    "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>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Search

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.