Skip to main content
POST
/
vdpEmails
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 '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "lead": 123,
  "vins": [
    123
  ],
  "createdBy": 123,
  "lastModifiedBy": 123,
  "vinCount": "<string>"
}
'
import requests

url = "https://commerce.driv.ly/api/vdpEmails"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "lead": 123,
    "vins": [123],
    "createdBy": 123,
    "lastModifiedBy": 123,
    "vinCount": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    lead: 123,
    vins: [123],
    createdBy: 123,
    lastModifiedBy: 123,
    vinCount: '<string>'
  })
};

fetch('https://commerce.driv.ly/api/vdpEmails', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://commerce.driv.ly/api/vdpEmails",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'lead' => 123,
    'vins' => [
        123
    ],
    'createdBy' => 123,
    'lastModifiedBy' => 123,
    'vinCount' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://commerce.driv.ly/api/vdpEmails"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"vins\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"lastModifiedBy\": 123,\n  \"vinCount\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://commerce.driv.ly/api/vdpEmails")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"vins\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"lastModifiedBy\": 123,\n  \"vinCount\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/vdpEmails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"lead\": 123,\n  \"vins\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"lastModifiedBy\": 123,\n  \"vinCount\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "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.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
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

200 - application/json

ok

doc
VdpEmail · object
required
message
string
required