Skip to main content
DELETE
/
searches
/
{id}
Deletes an existing Search
curl --request DELETE \
  --url https://commerce.driv.ly/api/searches/{id} \
  --header 'Authorization: <api-key>'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "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
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { searches } from '@drivly/commerce'

const sdk = new SDK(...)

const searches = await sdk.searches.delete(searchesId: string): Promise<void>

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

Response

ok

​
doc
Search · object
required
​
message
string
required