Skip to main content
PATCH
/
vdpEmails
/
{id}
Updates a Vdp Email
curl --request PATCH \
  --url https://commerce.driv.ly/api/vdpEmails/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "status": "Draft",
  "lead": 123,
  "vins": [
    123
  ],
  "createdBy": 123,
  "lastModifiedBy": 123,
  "vinCount": "<string>"
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "status": "Draft",
    "lead": 123,
    "vins": [
      123
    ],
    "createdBy": 123,
    "lastModifiedBy": 123,
    "vinCount": "<string>"
  },
  "message": "<string>"
}
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.update(vdpEmailsId: string, data: vdpEmails): Promise<vdpEmails>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
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

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
status
enum<string> | null
Available options:
Draft,
Send,
Sent
​
lead
​
vins
(number | Vehicle · object)[] | null
​
createdBy
number
​
lastModifiedBy
number
​
vinCount
string | null

Response

ok

​
doc
VdpEmail · object
required
​
message
string
required