Create a new Lead
curl --request POST \
--url https://commerce.driv.ly/api/leads \
--header 'Content-Type: application/json' \
--data '
{
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": [
"Vehicle ID Number"
],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": true
}
'import requests
url = "https://commerce.driv.ly/api/leads"
payload = {
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": ["Vehicle ID Number"],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'led_3k2jd9s8v2s4',
email: 'contact@example.com',
salesRep: 'SalesRep ID',
consumer: 'Consumer ID',
favorites: ['Vehicle ID Number'],
phoneNumber: '555-6789',
acceptsGeneratedMessages: true
})
};
fetch('https://commerce.driv.ly/api/leads', 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/leads",
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([
'id' => 'led_3k2jd9s8v2s4',
'email' => 'contact@example.com',
'salesRep' => 'SalesRep ID',
'consumer' => 'Consumer ID',
'favorites' => [
'Vehicle ID Number'
],
'phoneNumber' => '555-6789',
'acceptsGeneratedMessages' => true
]),
CURLOPT_HTTPHEADER => [
"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/leads"
payload := strings.NewReader("{\n \"id\": \"led_3k2jd9s8v2s4\",\n \"email\": \"contact@example.com\",\n \"salesRep\": \"SalesRep ID\",\n \"consumer\": \"Consumer ID\",\n \"favorites\": [\n \"Vehicle ID Number\"\n ],\n \"phoneNumber\": \"555-6789\",\n \"acceptsGeneratedMessages\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/leads")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"led_3k2jd9s8v2s4\",\n \"email\": \"contact@example.com\",\n \"salesRep\": \"SalesRep ID\",\n \"consumer\": \"Consumer ID\",\n \"favorites\": [\n \"Vehicle ID Number\"\n ],\n \"phoneNumber\": \"555-6789\",\n \"acceptsGeneratedMessages\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"led_3k2jd9s8v2s4\",\n \"email\": \"contact@example.com\",\n \"salesRep\": \"SalesRep ID\",\n \"consumer\": \"Consumer ID\",\n \"favorites\": [\n \"Vehicle ID Number\"\n ],\n \"phoneNumber\": \"555-6789\",\n \"acceptsGeneratedMessages\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": [
"Vehicle ID Number"
],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": true
},
"success": true
}{
"error": {
"code": 400,
"message": "Missing Required Information"
},
"success": false
}{
"error": {
"code": 401,
"message": "Unauthorized"
},
"success": false
}{
"error": {
"code": 429,
"message": "Too Many Requests"
},
"success": false
}Consumers
Create a new Lead
POST
/
leads
Create a new Lead
curl --request POST \
--url https://commerce.driv.ly/api/leads \
--header 'Content-Type: application/json' \
--data '
{
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": [
"Vehicle ID Number"
],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": true
}
'import requests
url = "https://commerce.driv.ly/api/leads"
payload = {
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": ["Vehicle ID Number"],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'led_3k2jd9s8v2s4',
email: 'contact@example.com',
salesRep: 'SalesRep ID',
consumer: 'Consumer ID',
favorites: ['Vehicle ID Number'],
phoneNumber: '555-6789',
acceptsGeneratedMessages: true
})
};
fetch('https://commerce.driv.ly/api/leads', 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/leads",
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([
'id' => 'led_3k2jd9s8v2s4',
'email' => 'contact@example.com',
'salesRep' => 'SalesRep ID',
'consumer' => 'Consumer ID',
'favorites' => [
'Vehicle ID Number'
],
'phoneNumber' => '555-6789',
'acceptsGeneratedMessages' => true
]),
CURLOPT_HTTPHEADER => [
"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/leads"
payload := strings.NewReader("{\n \"id\": \"led_3k2jd9s8v2s4\",\n \"email\": \"contact@example.com\",\n \"salesRep\": \"SalesRep ID\",\n \"consumer\": \"Consumer ID\",\n \"favorites\": [\n \"Vehicle ID Number\"\n ],\n \"phoneNumber\": \"555-6789\",\n \"acceptsGeneratedMessages\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/leads")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"led_3k2jd9s8v2s4\",\n \"email\": \"contact@example.com\",\n \"salesRep\": \"SalesRep ID\",\n \"consumer\": \"Consumer ID\",\n \"favorites\": [\n \"Vehicle ID Number\"\n ],\n \"phoneNumber\": \"555-6789\",\n \"acceptsGeneratedMessages\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"led_3k2jd9s8v2s4\",\n \"email\": \"contact@example.com\",\n \"salesRep\": \"SalesRep ID\",\n \"consumer\": \"Consumer ID\",\n \"favorites\": [\n \"Vehicle ID Number\"\n ],\n \"phoneNumber\": \"555-6789\",\n \"acceptsGeneratedMessages\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": [
"Vehicle ID Number"
],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": true
},
"success": true
}{
"error": {
"code": 400,
"message": "Missing Required Information"
},
"success": false
}{
"error": {
"code": 401,
"message": "Unauthorized"
},
"success": false
}{
"error": {
"code": 429,
"message": "Too Many Requests"
},
"success": false
}Query Parameters
The number of levels of related objects to include in the response
Body
application/json
Lead has Phone Number
Pattern:
^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$Lead has Email
Lead is uniquely identified by id
Sales Rep is assigned to Lead
Lead participates in transactions as Consumer
Lead favorites Vehicle
Lead accepts generated messages