JsonLead Type

object (JsonLead)

JsonLead Properties

Property	Type	Required	Nullable	Defined by
version	`string`	Required	cannot be null	JsonLead
customer	`object`	Required	cannot be null	JsonLead
sales_lead	`object`	Optional	cannot be null	JsonLead
appraisal_lead	`object`	Optional	cannot be null	JsonLead
aftersales_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:

"https://jsonlead.org/2.0.0/schema"

version Default Value

The default value is:

"https://jsonlead.org/2.0.0/schema"

customer

The customer object

customer

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

customer Type

object (Customer)

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 appraisal lead.

appraisal_lead

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

appraisal_lead Type

object (Appraisal lead)

aftersales_lead

The aftersales lead.

aftersales_lead

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

aftersales_lead Type

object (Aftersales lead)

JsonLead Definitions

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/gdpr"}

Property	Type	Required	Nullable	Defined by
provider	`object`	Optional	cannot be null	JsonLead
created_at	`string`	Optional	cannot be null	JsonLead
marketing	`boolean`	Optional	cannot be null	JsonLead
profiling	`boolean`	Optional	cannot be null	JsonLead
third_party	`boolean`	Optional	cannot be null	JsonLead

provider

provider

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

provider Type

object (GDPR Provider)

created_at

The creation date of the consent. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

marketing

Whether or not the customer has given consent to receive marketing communications

marketing

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

marketing Type

boolean

profiling

Whether or not the customer has given consent to use his or her data for profiling

profiling

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

profiling Type

boolean

third_party

Whether or not the customer has given consent to send his data to third party companies

third_party

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

third_party Type

boolean

Definitions group address

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/address"}

Property	Type	Required	Nullable	Defined by
country	`string`	Optional	cannot be null	JsonLead
area_level_1	`string`	Optional	cannot be null	JsonLead
area_level_2	`string`	Optional	cannot be null	JsonLead
area_level_3	`string`	Optional	cannot be null	JsonLead
postal_code	`string`	Optional	cannot be null	JsonLead
locality	`string`	Optional	cannot be null	JsonLead
route	`string`	Optional	cannot be null	JsonLead
street_number	`string`	Optional	cannot be null	JsonLead
address_details	`string`	Optional	cannot be null	JsonLead

country

Country code of the address (Following ISO 3166-1 alpha-2)

country

is optional
Type: string (Country)
cannot be null
defined in: JsonLead

country Type

string (Country)

area_level_1

Level 1 administrative division of the address (Community, State). See https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country for more information

area_level_1

is optional
Type: string (Area level 1)
cannot be null
defined in: JsonLead

area_level_1 Type

string (Area level 1)

area_level_2

Level 2 administrative division of the address (Province, County). See https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country for more information

area_level_2

is optional
Type: string (Area level 2)
cannot be null
defined in: JsonLead

area_level_2 Type

string (Area level 2)

area_level_3

Level 3 administrative division of the address (French arrondissements). See https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country for more information

area_level_3

is optional
Type: string (Area level 3)
cannot be null
defined in: JsonLead

area_level_3 Type

string (Area level 3)

postal_code

Postal code of the address

postal_code

is optional
Type: string (Postal Code)
cannot be null
defined in: JsonLead

postal_code Type

string (Postal Code)

locality

Municipalities of the address (Town, City)

locality

is optional
Type: string (Locality)
cannot be null
defined in: JsonLead

locality Type

string (Locality)

route

Street name of the address

route

is optional
Type: string (Route)
cannot be null
defined in: JsonLead

route Type

string (Route)

street_number

Street number of the address

street_number

is optional
Type: string (Street number)
cannot be null
defined in: JsonLead

street_number Type

string (Street number)

address_details

Additional details about the address

address_details

is optional
Type: string (Adress details)
cannot be null
defined in: JsonLead

address_details Type

string (Adress details)

Definitions group customer

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/customer"}

Property	Type	Required	Nullable	Defined by
ids	`array`	Optional	cannot be null	JsonLead
created_at	`string`	Optional	cannot be null	JsonLead
business_details	`object`	Optional	cannot be null	JsonLead
contacts	`array`	Optional	cannot be null	JsonLead
address	`object`	Optional	cannot be null	JsonLead
owned_vehicles	`array`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

ids

A list of unique identifiers from your -and/or third party- databases or systems. This ID can be used by lead managers to corss-reference and update customer information

ids

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

ids Type

string[]

created_at

The creation date of the customer. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

business_details

For business accounts, information related to the company

business_details

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

business_details Type

object (Details)

contacts

contacts

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

contacts Type

object[] (Details)

address

Addess of the customer

address

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

address Type

object (Details)

owned_vehicles

owned vehicles of the customer

owned_vehicles

is optional
Type: an array of merged types (Details)
cannot be null
defined in: JsonLead

owned_vehicles Type

an array of merged types (Details)

custom

Custom fields for the customer

custom

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

custom Type

object (Details)

Definitions group aftersales_lead

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/aftersales_lead"}

Property	Type	Required	Nullable	Defined by
created_at	`string`	Optional	cannot be null	JsonLead
ids	`array`	Optional	cannot be null	JsonLead
assigned_to	`string`	Optional	cannot be null	JsonLead
status	`object`	Optional	cannot be null	JsonLead
type	`string`	Optional	cannot be null	JsonLead
vehicle	Merged	Optional	cannot be null	JsonLead
origin	`object`	Optional	cannot be null	JsonLead
dealer_location	`string`	Optional	cannot be null	JsonLead
tasks	`array`	Optional	cannot be null	JsonLead
offers	`array`	Optional	cannot be null	JsonLead
appointments	`array`	Optional	cannot be null	JsonLead
comments	`array`	Optional	cannot be null	JsonLead
related_urls	`array`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

created_at

The creation date of the lead. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

ids

A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the aftersales lead on the destination database with the external system.

ids

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

ids Type

string[]

assigned_to

The user assigned to the aftersale

assigned_to

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

assigned_to Type

string

status

The aftersales lead statuses

status

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

status Type

object (Details)

type

The type of the lead

type

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

type Type

string

vehicle

The vehicle associated with this aftersale

vehicle

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

vehicle Type

merged type (Details)

all of

Vehicle

origin

The aftersale origin

origin

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

origin Type

object (Origin)

dealer_location

The location of the aftersale

dealer_location

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

dealer_location Type

string

tasks

Task objects to associate with the aftersale

tasks

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

tasks Type

object[] (Task)

offers

Offer objects to associate with the aftersale

offers

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

offers Type

object[] (Offer)

appointments

Appointment objects to associate with the aftersale

appointments

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

appointments Type

object[] (Appointment)

comments

Comment objects to associate with the aftersale

comments

is optional
Type: object[] (Comment)
cannot be null
defined in: JsonLead

comments Type

object[] (Comment)

related_urls

An array of URLs with information related to the aftersale

related_urls

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

related_urls Type

string[]

custom

Custom fields for the aftersale

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.0.0.schema.json#/definitions/sales_lead"}

Property	Type	Required	Nullable	Defined by
created_at	`string`	Optional	cannot be null	JsonLead
finance	`object`	Optional	cannot be null	JsonLead
ids	`array`	Optional	cannot be null	JsonLead
assigned_to	`string`	Optional	cannot be null	JsonLead
status	`object`	Optional	cannot be null	JsonLead
vehicles	`array`	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
tasks	`array`	Optional	cannot be null	JsonLead
offers	`array`	Optional	cannot be null	JsonLead
appointments	`array`	Optional	cannot be null	JsonLead
comments	`array`	Optional	cannot be null	JsonLead
related_urls	`array`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

created_at

The creation date of the lead. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

finance

Information about the finance operation

finance

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

finance Type

object (Details)

ids

A list of unique identifiers 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.

ids

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

ids 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 aftersales lead statuses

status

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

status Type

object (Details)

vehicles

The vehicles associated with this sale

vehicles

is optional
Type: an array of merged types (Details)
cannot be null
defined in: JsonLead

vehicles Type

an array of merged types (Details)

origin

The origin of the 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

tasks

Task objects to associate with the sale

tasks

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

tasks Type

object[] (Task)

offers

Offer objects to associate with the sale

offers

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

offers Type

object[] (Offer)

appointments

Appointment objects to associate with the sale

appointments

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

appointments Type

object[] (Appointment)

comments

Comment objects to associate with the sale

comments

is optional
Type: object[] (Comment)
cannot be null
defined in: JsonLead

comments Type

object[] (Comment)

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.0.0.schema.json#/definitions/appraisal_lead"}

Property	Type	Required	Nullable	Defined by
created_at	`string`	Optional	cannot be null	JsonLead
ids	`array`	Optional	cannot be null	JsonLead
assigned_to	`string`	Optional	cannot be null	JsonLead
status	`object`	Optional	cannot be null	JsonLead
vehicles	`array`	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
tasks	`array`	Optional	cannot be null	JsonLead
offers	`array`	Optional	cannot be null	JsonLead
appointments	`array`	Optional	cannot be null	JsonLead
comments	`array`	Optional	cannot be null	JsonLead
related_urls	`array`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

created_at

The creation date of the lead. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

ids

A list of unique identifiers 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.

ids

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

ids 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 aftersales lead statuses

status

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

status Type

object (Details)

vehicles

vehicles

is optional
Type: an array of merged types (Details)
cannot be null
defined in: JsonLead

vehicles Type

an array of merged types (Details)

origin

The appraisal origin

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 vehicles

appraisal_value

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

appraisal_value Type

number

tasks

Task objects to associate with the appraisal

tasks

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

tasks Type

object[] (Task)

offers

Offer objects to associate with the sale

offers

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

offers Type

object[] (Offer)

appointments

Appointment objects to associate with the appraisal

appointments

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

appointments Type

object[] (Appointment)

comments

Comment objects to associate with the appraisal

comments

is optional
Type: object[] (Comment)
cannot be null
defined in: JsonLead

comments Type

object[] (Comment)

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 vehicle

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/vehicle"}

Property	Type	Required	Nullable	Defined by
ids	`array`	Optional	cannot be null	JsonLead
type	`string`	Optional	cannot be null	JsonLead
category	`string`	Optional	cannot be null	JsonLead
stock_number	`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
prices	`array`	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
seats	`number`	Optional	cannot be null	JsonLead
warranty_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
colors	`array`	Optional	cannot be null	JsonLead
urls	`array`	Optional	cannot be null	JsonLead
dealer_location	`string`	Optional	cannot be null	JsonLead
media	`array`	Optional	cannot be null	JsonLead
engine_size	`number`	Optional	cannot be null	JsonLead
equipment	`array`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

ids

A list of unique identifiers from your -and/or third party- databases or systems. This ID can be used by lead managers to corss-reference and update customer information

ids

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

ids Type

string[]

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_number

Vehicle's human readable or friendly unique identifier from the Dealer Archives

stock_number

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

stock_number Type

string

body_style

Body style

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

Year manufactured

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

Month Manufactured

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

prices

Vehicle prices

prices

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

prices Type

object[] (Details)

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

seats

Number of seats

seats

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

seats Type

number

seats Constraints

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

warranty_months

Duration of the warranty in months

warranty_months

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

warranty_months Type

number

warranty_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 (HP, CV)

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

colors

Colors of the vehicle

colors

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

colors Type

object[] (Details)

urls

Vehicle detail page URLS

urls

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

urls Type

string[]

dealer_location

The location of the vehicle

dealer_location

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

dealer_location Type

string

media

Vehicle media (Photos, Videos, 3D Models, etc)

media

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

media Type

object[] (Details)

engine_size

Engine volume (cc3)

engine_size

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

engine_size Type

number

equipment

Vehicle equipment

equipment

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

equipment Type

object[] (Details)

custom

Custom fields for the vehicle

custom

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

custom Type

object (Details)

Definitions group origin

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.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.0.0.schema.json#/definitions/task"}

Property	Type	Required	Nullable	Defined by
ids	`array`	Optional	cannot be null	JsonLead
created_at	`string`	Optional	cannot be null	JsonLead
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

ids

A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the task on the destination database with the external system.

ids

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

ids Type

string[]

created_at

The creation date of the task. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

due_date

The due date of the task. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

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.0.0.schema.json#/definitions/offer"}

Property	Type	Required	Nullable	Defined by
ids	`array`	Optional	cannot be null	JsonLead
amount	`number`	Optional	cannot be null	JsonLead
description	`string`	Optional	cannot be null	JsonLead
created_at	`string`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

ids

A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the offer on the destination database with the external system.

ids

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

ids Type

string[]

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

created_at

The creation date of the offer. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

custom

Custom fields for the offer

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.0.0.schema.json#/definitions/appointment"}

Property	Type	Required	Nullable	Defined by
ids	`array`	Optional	cannot be null	JsonLead
created_at	`string`	Optional	cannot be null	JsonLead
start_date	`string`	Optional	cannot be null	JsonLead
end_date	`string`	Optional	cannot be null	JsonLead
assigned_to	`string`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

ids

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

ids

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

ids Type

string[]

created_at

The creation date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

start_date

The start date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

start_date

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

start_date Type

string

start_date Constraints

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

end_date

The end date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

end_date

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

end_date Type

string

end_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.0.0.schema.json#/definitions/comment"}

Property	Type	Required	Nullable	Defined by
ids	`array`	Optional	cannot be null	JsonLead
created_at	`string`	Optional	cannot be null	JsonLead
content	`string`	Optional	cannot be null	JsonLead
custom	`object`	Optional	cannot be null	JsonLead

ids

A list of unique identifiers that originates from an external database or system. It is meant to cross-reference the comment on the destination database with the external system.

ids

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

ids Type

string[]

created_at

The creation date of the comment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)

created_at

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

created_at Type

string

created_at Constraints

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

content

Content of the comment

content

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

content Type

string

custom

Custom fields for the comment

custom

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

custom Type

object (Details)

Definitions group price

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v2.0.0.schema.json#/definitions/price"}

Property	Type	Required	Nullable	Defined by
type	`string`	Optional	cannot be null	JsonLead
amount	`number`	Optional	cannot be null	JsonLead
currency	`string`	Optional	cannot be null	JsonLead

type

The type of the price

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
`"retail"`
`"wholesale"`
`"msrp"`
`"export"`

amount

The price amount

amount

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

amount Type

number

currency

The currency of the price (ISO 4217)

currency

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

currency Type

string

JsonLead Type

JsonLead Properties

version

version Type

version Constraints

version Default Value

customer

customer Type

sales_lead

sales_lead Type

appraisal_lead

appraisal_lead Type

aftersales_lead

aftersales_lead Type

JsonLead Definitions

Definitions group gdpr

provider

provider Type

created_at

created_at Type

created_at Constraints

marketing

marketing Type

profiling

profiling Type

third_party

third_party Type

Definitions group address

country

country Type

area_level_1

area_level_1 Type

area_level_2

area_level_2 Type

area_level_3

area_level_3 Type

postal_code

postal_code Type

locality

locality Type

route

route Type

street_number

street_number Type

address_details

address_details Type

Definitions group customer

ids

ids Type

created_at

created_at Type

created_at Constraints

business_details

business_details Type

contacts

contacts Type

address

address Type

owned_vehicles

owned_vehicles Type

custom

custom Type

Definitions group aftersales_lead

created_at

created_at Type

created_at Constraints

ids

ids Type

assigned_to

assigned_to Type

status

status Type

type

type Type

vehicle

vehicle Type

origin

origin Type

dealer_location

dealer_location Type