Deletes an existing Vdp Email

curl --request DELETE \
  --url https://commerce.driv.ly/api/vdpEmails/{id} \
  --header 'Authorization: <api-key>'

{
  "doc": {
    "status": "Draft",
    "lead": 123,
    "vins": [
      123
    ],
    "createdBy": 123,
    "lastModifiedBy": 123,
    "vinCount": "<string>",
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

DELETE

vdpEmails

{id}

Deletes an existing Vdp Email

curl --request DELETE \
  --url https://commerce.driv.ly/api/vdpEmails/{id} \
  --header 'Authorization: <api-key>'

{
  "doc": {
    "status": "Draft",
    "lead": 123,
    "vins": [
      123
    ],
    "createdBy": 123,
    "lastModifiedBy": 123,
    "vinCount": "<string>",
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

Usage with the Drivly SDK

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { vdpEmails } from '@drivly/commerce'

const sdk = new SDK(...)

const vdpEmails = await sdk.vdpEmails.delete(vdpEmailsId: string): Promise<void>

Authorizations

Authorization

string

header

required

Path Parameters

string

required

id of the Vdp Email

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

200

application/json

The response is of type object.

Get a single Vdp Email by its id Updates a Vdp Email

Commerce

Resources

API Reference

Deletes an existing Vdp Email

Authorizations

Path Parameters

Query Parameters

Response