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

is required
Type: string
cannot be null
defined in: JsonLead

version Type

string

version Constraints

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

"1.0.0"

client

The client object

client

is required
Type: object (Client)
cannot be null
defined in: JsonLead

client Type

object (Client)

sales_lead

The sales lead.

sales_lead

is optional
Type: object (Sales lead)
cannot be null
defined in: JsonLead

sales_lead Type

object (Sales lead)

appraisal_lead

The appraisallead

appraisal_lead

is optional
Type: object (Appraisal lead)
cannot be null
defined in: JsonLead

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 that originates from an external database or system. It is meant to cross-reference the client on the destination database with the external system.

foreign_id

is optional
Type: string
cannot be null
defined in: JsonLead

foreign_id Type

string

first_name

The first name of the client

first_name

is optional
Type: string
cannot be null
defined in: JsonLead

first_name Type

string

last_name

The last name of the client

last_name

is optional
Type: string
cannot be null
defined in: JsonLead

last_name Type

string

gdpr_consents

gdpr_consents

is optional
Type: object (GDPR Consents)
cannot be null
defined in: JsonLead

gdpr_consents Type

object (GDPR Consents)

province

The province of the client

province

is optional
Type: string
cannot be null
defined in: JsonLead

province Type

string

postal_code

The postal code of the client

postal_code

is optional
Type: string
cannot be null
defined in: JsonLead

postal_code Type

string

phone

phone

is optional
Type: merged type (Details)
cannot be null
defined in: JsonLead

phone Type

merged type (Details)

one (and only one) of

email

email

is optional
Type: merged type (Details)
cannot be null
defined in: JsonLead

email Type

merged type (Details)

one (and only one) of

custom

Custom fields for the client

custom

is optional
Type: object (Details)
cannot be null
defined in: JsonLead

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 that originates from an external database or system. It is meant to cross-reference the sales lead on the destination database with the external system.

foreign_id

is optional
Type: string
cannot be null
defined in: JsonLead

foreign_id Type

string

assigned_to

The user assigned to the sale

assigned_to

is optional
Type: string
cannot be null
defined in: JsonLead

assigned_to Type

string

status

The sales lead status

status

is optional
Type: string
cannot be null
defined in: JsonLead

status Type

string

car

The car associated with this sale

car

is optional
Type: object (Car)
cannot be null
defined in: JsonLead

car Type

object (Car)

origin

The car associated with this sale

origin

is optional
Type: object (Origin)
cannot be null
defined in: JsonLead

origin Type

object (Origin)

type

The type of the lead

type

is optional
Type: string
cannot be null
defined in: JsonLead

type Type

string

dealer_location

The location of the sale

dealer_location

is optional
Type: string
cannot be null
defined in: JsonLead

dealer_location Type

string

inquiry

The sale inquiry

inquiry

is optional
Type: string
cannot be null
defined in: JsonLead

inquiry Type

string

task

A task object to associate with the sale

task

is optional
Type: object (Task)
cannot be null
defined in: JsonLead

task Type

object (Task)

offer

An offer object to associate with the sale

offer

is optional
Type: object (Offer)
cannot be null
defined in: JsonLead

offer Type

object (Offer)

appointment

An appointment object to associate with the sale

appointment

is optional
Type: object (Appointment)
cannot be null
defined in: JsonLead

appointment Type

object (Appointment)

comment

The comment contents

comment

is optional
Type: string
cannot be null
defined in: JsonLead

comment Type

string

related_urls

An array of URLs with information related to the sale

related_urls

is optional
Type: string[]
cannot be null
defined in: JsonLead

related_urls Type

string[]

custom

Custom fields for the sale

custom

is optional
Type: object (Details)
cannot be null
defined in: JsonLead

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 that originates from an external database or system. It is meant to cross-reference the appraisal lead on the destination database with the external system.

foreign_id

is optional
Type: string
cannot be null
defined in: JsonLead

foreign_id Type

string

assigned_to

The username assigned to the appraisal

assigned_to

is optional
Type: string
cannot be null
defined in: JsonLead

assigned_to Type

string

status

The appraisal state

status

is optional
Type: string
cannot be null
defined in: JsonLead

status Type

string

car

The car associated with this appraisal

car

is optional
Type: object (Car)
cannot be null
defined in: JsonLead

car Type

object (Car)

origin

The car associated with this appraisal

origin

is optional
Type: object (Origin)
cannot be null
defined in: JsonLead

origin Type

object (Origin)

type

The type of the lead

type

is optional
Type: string
cannot be null
defined in: JsonLead

type Type

string

dealer_location

The location of the appraisal

dealer_location

is optional
Type: string
cannot be null
defined in: JsonLead

dealer_location Type

string

appraisal_value

The appraised value for the car

appraisal_value

is optional
Type: number
cannot be null
defined in: JsonLead

appraisal_value Type

number

task

A task object to associate with the appraisal

task

is optional
Type: object (Task)
cannot be null
defined in: JsonLead

task Type

object (Task)

offer

An offer object to associate with the sale

offer

is optional
Type: object (Offer)
cannot be null
defined in: JsonLead

offer Type

object (Offer)

appointment

An appointment object to associate with the appraisal

appointment

is optional
Type: object (Appointment)
cannot be null
defined in: JsonLead

appointment Type

object (Appointment)

comment

The comment contents

comment

is optional
Type: string
cannot be null
defined in: JsonLead

comment Type

string

related_urls

An array of URLs with information related to the appraisal

related_urls

is optional
Type: string[]
cannot be null
defined in: JsonLead

related_urls Type

string[]

custom

Custom fields for the appraisal

custom

is optional
Type: object (Details)
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

type Type

string

type Constraints

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

Value	Explanation
`"new"`
`"used"`

Value	Explanation
`"car"`
`"motorcycle"`
`"industrial"`

stock_id

An unique identifier for the car

stock_id

is optional
Type: string
cannot be null
defined in: JsonLead

stock_id Type

string

body_style

Body type

body_style

is optional
Type: string
cannot be null
defined in: JsonLead

body_style Type

string

make

Make

make

is optional
Type: string
cannot be null
defined in: JsonLead

make Type

string

model

Model

model

is optional
Type: string
cannot be null
defined in: JsonLead

model Type

string

version

version

is optional
Type: string
cannot be null
defined in: JsonLead

version Type

string

year

Fabrication year

year

is optional
Type: number
cannot be null
defined in: JsonLead

year Type

number

year Constraints

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

month

Fabrication month

month

is optional
Type: number
cannot be null
defined in: JsonLead

month Type

number

month Constraints

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

price

Price

price

is optional
Type: number
cannot be null
defined in: JsonLead

price Type

number

license_plate

License place

license_plate

is optional
Type: string
cannot be null
defined in: JsonLead

license_plate Type

string

mileage

Mileage

mileage

is optional
Type: number
cannot be null
defined in: JsonLead

mileage Type

number

mileage Constraints

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

doors

Number of doors

doors

is optional
Type: number
cannot be null
defined in: JsonLead

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

is optional
Type: number
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

vin Type

string

fuel

Fuel Type

fuel

is optional
Type: string
cannot be null
defined in: JsonLead

fuel Type

string

transmission

Transmission Type

transmission

is optional
Type: string
cannot be null
defined in: JsonLead

transmission Type

string

horsepower

Horsepower

horsepower

is optional
Type: number
cannot be null
defined in: JsonLead

horsepower Type

number

horsepower Constraints

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

color

Color

color

is optional
Type: string
cannot be null
defined in: JsonLead

color Type

string

url

Car publication URL

url

is optional
Type: string
cannot be null
defined in: JsonLead

url Type

string

url Constraints

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

image_urls

Car's images' URLs

image_urls

is optional
Type: string[]
cannot be null
defined in: JsonLead

image_urls Type

string[]

engine_size

Engine volume (cc3)

engine_size

is optional
Type: number
cannot be null
defined in: JsonLead

engine_size Type

number

equipment

Extras

equipment

is optional
Type: string
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

source Type

string

medium

The medium of the lead

medium

is optional
Type: string
cannot be null
defined in: JsonLead

medium Type

string

campaign

The campaign of the lead

campaign

is optional
Type: string
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

assigned_to Type

string

description

The task description

description

is optional
Type: string
cannot be null
defined in: JsonLead

description Type

string

custom

Custom fields for the task

custom

is optional
Type: object (Details)
cannot be null
defined in: JsonLead

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

is optional
Type: number
cannot be null
defined in: JsonLead

amount Type

number

description

The description of the offer

description

is optional
Type: string
cannot be null
defined in: JsonLead

description Type

string

date

The creation date of the offer

date

is optional
Type: string
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

type Type

string

custom

Custom fields for the appointment

custom

is optional
Type: object (Details)
cannot be null
defined in: JsonLead

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
foreign_id	`string`	Optional	cannot be null	JsonLead
due_date	`string`	Optional	cannot be null	JsonLead
assigned_to	`string`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

foreign_id

A unique identifier that originates from an external database or system. It is meant to cross-reference the appointment on the destination database with the external system.

foreign_id

is optional
Type: string
cannot be null
defined in: JsonLead

foreign_id Type

string

due_date

The date of the appointment

due_date

is optional
Type: string
cannot be null
defined in: JsonLead

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

is optional
Type: string
cannot be null
defined in: JsonLead

assigned_to Type

string

custom

Custom fields for the appointment

custom

is optional
Type: object (Details)
cannot be null
defined in: JsonLead

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