Create a new Vdp Email

POST

vdpEmails

curl --request POST \
  --url https://commerce.driv.ly/api/vdpEmails \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "Draft",
  "lead": 123,
  "vins": [
    123
  ],
  "createdBy": 123,
  "lastModifiedBy": 123,
  "vinCount": "<string>",
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'

{
  "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.create(data: vdpEmails): Promise<vdpEmails>

Authorizations

Authorization

string

header

required

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

The response is of type object.

Find paginated Vdp Emails Delete multiple Vdp Emails

Create a new Vdp Email

curl --request POST \
  --url https://commerce.driv.ly/api/vdpEmails \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "Draft",
  "lead": 123,
  "vins": [
    123
  ],
  "createdBy": 123,
  "lastModifiedBy": 123,
  "vinCount": "<string>",
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'

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

Commerce

Resources

API Reference

Create a new Vdp Email

Authorizations

Query Parameters

Body

Response