JsonLead Type

object (JsonLead)

JsonLead Properties

Property Type Required Nullable Defined by
version string Required cannot be null JsonLead
client object Required cannot be null JsonLead
sales_lead object Optional cannot be null JsonLead
appraisal_lead object Optional cannot be null JsonLead

version

Version of the JSONLead schema

version

version Type

string

version Constraints

constant: the value of this property must be equal to:

"1.0.0"

client

The client object

client

client Type

object (Client)

sales_lead

The sales lead.

sales_lead

sales_lead Type

object (Sales lead)

appraisal_lead

The appraisallead

appraisal_lead

appraisal_lead Type

object (Appraisal lead)

JsonLead Definitions

Definitions group client

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/client"}
Property Type Required Nullable Defined by
foreign_id string Optional cannot be null JsonLead
first_name string Optional cannot be null JsonLead
last_name string Optional cannot be null JsonLead
gdpr_consents object Optional cannot be null JsonLead
province string Optional cannot be null JsonLead
postal_code string Optional cannot be null JsonLead
phone Merged Optional cannot be null JsonLead
email Merged Optional cannot be null JsonLead
custom object Optional cannot be null JsonLead

foreign_id

A unique identifier for the client

foreign_id

foreign_id Type

string

first_name

The first name of the client

first_name

first_name Type

string

last_name

The last name of the client

last_name

last_name Type

string

gdpr_consents

gdpr_consents

gdpr_consents Type

object (GDPR Consents)

province

The province of the client

province

province Type

string

postal_code

The postal code of the client

postal_code

postal_code Type

string

phone

phone

phone Type

merged type (Details)

one (and only one) of

email

email

email Type

merged type (Details)

one (and only one) of

custom

Custom fields for the client

custom

custom Type

object (Details)

Definitions group sales_lead

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/sales_lead"}
Property Type Required Nullable Defined by
foreign_id string Optional cannot be null JsonLead
assigned_to string Optional cannot be null JsonLead
status string Optional cannot be null JsonLead
car object Optional cannot be null JsonLead
origin object Optional cannot be null JsonLead
type string Optional cannot be null JsonLead
dealer_location string Optional cannot be null JsonLead
inquiry string Optional cannot be null JsonLead
task object Optional cannot be null JsonLead
offer object Optional cannot be null JsonLead
appointment object Optional cannot be null JsonLead
comment string Optional cannot be null JsonLead
related_urls array Optional cannot be null JsonLead
custom object Optional cannot be null JsonLead

foreign_id

A unique identifier for the sale

foreign_id

foreign_id Type

string

assigned_to

The user assigned to the sale

assigned_to

assigned_to Type

string

status

The sales lead status

status

status Type

string

car

The car associated with this sale

car

car Type

object (Car)

origin

The car associated with this sale

origin

origin Type

object (Origin)

type

The type of the lead

type

type Type

string

dealer_location

The location of the sale

dealer_location

dealer_location Type

string

inquiry

The sale inquiry

inquiry

inquiry Type

string

task

A task object to associate with the sale

task

task Type

object (Task)

offer

An offer object to associate with the sale

offer

offer Type

object (Offer)

appointment

An appointment object to associate with the sale

appointment

appointment Type

object (Appointment)

comment

The comment contents

comment

comment Type

string

An array of URLs with information related to the sale

related_urls

string[]

custom

Custom fields for the sale

custom

custom Type

object (Details)

Definitions group appraisal_lead

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/appraisal_lead"}
Property Type Required Nullable Defined by
foreign_id string Optional cannot be null JsonLead
assigned_to string Optional cannot be null JsonLead
status string Optional cannot be null JsonLead
car object Optional cannot be null JsonLead
origin object Optional cannot be null JsonLead
type string Optional cannot be null JsonLead
dealer_location string Optional cannot be null JsonLead
appraisal_value number Optional cannot be null JsonLead
task object Optional cannot be null JsonLead
offer object Optional cannot be null JsonLead
appointment object Optional cannot be null JsonLead
comment string Optional cannot be null JsonLead
related_urls array Optional cannot be null JsonLead
custom object Optional cannot be null JsonLead

foreign_id

A unique identifier for the appraisal

foreign_id

foreign_id Type

string

assigned_to

The username assigned to the appraisal

assigned_to

assigned_to Type

string

status

The appraisal state

status

status Type

string

car

The car associated with this appraisal

car

car Type

object (Car)

origin

The car associated with this appraisal

origin

origin Type

object (Origin)

type

The type of the lead

type

type Type

string

dealer_location

The location of the appraisal

dealer_location

dealer_location Type

string

appraisal_value

The appraised value for the car

appraisal_value

appraisal_value Type

number

task

A task object to associate with the appraisal

task

task Type

object (Task)

offer

An offer object to associate with the sale

offer

offer Type

object (Offer)

appointment

An appointment object to associate with the appraisal

appointment

appointment Type

object (Appointment)

comment

The comment contents

comment

comment Type

string

An array of URLs with information related to the appraisal

related_urls

string[]

custom

Custom fields for the appraisal

custom

custom Type

object (Details)

Definitions group car

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/car"}
Property Type Required Nullable Defined by
type string Optional cannot be null JsonLead
category string Optional cannot be null JsonLead
stock_id string Optional cannot be null JsonLead
body_style string Optional cannot be null JsonLead
make string Optional cannot be null JsonLead
model string Optional cannot be null JsonLead
version string Optional cannot be null JsonLead
year number Optional cannot be null JsonLead
month number Optional cannot be null JsonLead
price number Optional cannot be null JsonLead
license_plate string Optional cannot be null JsonLead
mileage number Optional cannot be null JsonLead
doors number Optional cannot be null JsonLead
warraty_months number Optional cannot be null JsonLead
vin string Optional cannot be null JsonLead
fuel string Optional cannot be null JsonLead
transmission string Optional cannot be null JsonLead
horsepower number Optional cannot be null JsonLead
color string Optional cannot be null JsonLead
url string Optional cannot be null JsonLead
image_urls array Optional cannot be null JsonLead
engine_size number Optional cannot be null JsonLead
equipment string Optional cannot be null JsonLead

type

Type

type

type Type

string

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"new"
"used"

category

The vehicle category

category

category Type

string

category Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"car"
"motorcycle"
"industrial"

stock_id

An unique identifier for the car

stock_id

stock_id Type

string

body_style

Body type

body_style

body_style Type

string

make

Make

make

make Type

string

model

Model

model

model Type

string

version

version

version Type

string

year

Fabrication year

year

year Type

number

year Constraints

minimum: the value of this number must greater than or equal to: 0

month

Fabrication month

month

month Type

number

month Constraints

minimum: the value of this number must greater than or equal to: 0

price

Price

price

price Type

number

license_plate

License place

license_plate

license_plate Type

string

mileage

Mileage

mileage

mileage Type

number

mileage Constraints

minimum: the value of this number must greater than or equal to: 0

doors

Number of doors

doors

doors Type

number

doors Constraints

minimum: the value of this number must greater than or equal to: 0

warraty_months

Duration of the warranty in months

warraty_months

warraty_months Type

number

warraty_months Constraints

minimum: the value of this number must greater than or equal to: 0

vin

Vehicle Identification Number

vin

vin Type

string

fuel

Fuel Type

fuel

fuel Type

string

transmission

Transmission Type

transmission

transmission Type

string

horsepower

Horsepower

horsepower

horsepower Type

number

horsepower Constraints

minimum: the value of this number must greater than or equal to: 0

color

Color

color

color Type

string

url

Car publication URL

url

url Type

string

url Constraints

URI: the string must be a URI, according to RFC 3986

image_urls

Car's images' URLs

image_urls

image_urls Type

string[]

engine_size

Engine volume (cc3)

engine_size

engine_size Type

number

equipment

Extras

equipment

equipment Type

string

Definitions group origin

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/origin"}
Property Type Required Nullable Defined by
source string Optional cannot be null JsonLead
medium string Optional cannot be null JsonLead
campaign string Optional cannot be null JsonLead

source

The source of the lead

source

source Type

string

medium

The medium of the lead

medium

medium Type

string

campaign

The campaign of the lead

campaign

campaign Type

string

Definitions group task

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/task"}
Property Type Required Nullable Defined by
due_date string Optional cannot be null JsonLead
assigned_to string Optional cannot be null JsonLead
description string Optional cannot be null JsonLead
custom object Optional cannot be null JsonLead

due_date

The due date of the task

due_date

due_date Type

string

due_date Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

assigned_to

The user assigned to this task

assigned_to

assigned_to Type

string

description

The task description

description

description Type

string

custom

Custom fields for the task

custom

custom Type

object (Details)

Definitions group offer

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/offer"}
Property Type Required Nullable Defined by
amount number Optional cannot be null JsonLead
description string Optional cannot be null JsonLead
date string Optional cannot be null JsonLead
type string Optional cannot be null JsonLead
custom object Optional cannot be null JsonLead

amount

The offered amount, in the local currency

amount

amount Type

number

description

The description of the offer

description

description Type

string

date

The creation date of the offer

date

date Type

string

date Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

type

The type of the offer

type

type Type

string

custom

Custom fields for the appointment

custom

custom Type

object (Details)

Definitions group appointment

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/appointment"}
Property Type Required Nullable Defined by
due_date string Optional cannot be null JsonLead
assigned_to string Optional cannot be null JsonLead
custom object Optional cannot be null JsonLead

due_date

The date of the appointment

due_date

due_date Type

string

due_date Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

assigned_to

The user assigned to the appointment

assigned_to

assigned_to Type

string

custom

Custom fields for the appointment

custom

custom Type

object (Details)

Definitions group comment

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.schema.json#/definitions/comment"}
Property Type Required Nullable Defined by