object
(JsonLead)
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 of the JSONLead schema
version
is required
Type: string
cannot be null
defined in: JsonLead
string
constant: the value of this property must be equal to:
"1.0.0"
The client object
client
object
(Client)
The sales lead.
sales_lead
is optional
Type: object
(Sales lead)
cannot be null
defined in: JsonLead
object
(Sales lead)
The appraisallead
appraisal_lead
is optional
Type: object
(Appraisal lead)
cannot be null
defined in: JsonLead
object
(Appraisal lead)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
Merged | Optional | cannot be null | JsonLead | |
custom | object |
Optional | cannot be null | JsonLead |
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
string
The first name of the client
first_name
is optional
Type: string
cannot be null
defined in: JsonLead
string
The last name of the client
last_name
is optional
Type: string
cannot be null
defined in: JsonLead
string
gdpr_consents
is optional
Type: object
(GDPR Consents)
cannot be null
defined in: JsonLead
object
(GDPR Consents)
The province of the client
province
is optional
Type: string
cannot be null
defined in: JsonLead
string
The postal code of the client
postal_code
is optional
Type: string
cannot be null
defined in: JsonLead
string
phone
merged type (Details)
one (and only one) of
email
merged type (Details)
one (and only one) of
Custom fields for the client
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
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
string
The user assigned to the sale
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The sales lead status
status
is optional
Type: string
cannot be null
defined in: JsonLead
string
The car associated with this sale
car
object
(Car)
The car associated with this sale
origin
object
(Origin)
The type of the lead
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
The location of the sale
dealer_location
is optional
Type: string
cannot be null
defined in: JsonLead
string
The sale inquiry
inquiry
is optional
Type: string
cannot be null
defined in: JsonLead
string
A task object to associate with the sale
task
object
(Task)
An offer object to associate with the sale
offer
object
(Offer)
An appointment object to associate with the sale
appointment
is optional
Type: object
(Appointment)
cannot be null
defined in: JsonLead
object
(Appointment)
The comment contents
comment
is optional
Type: string
cannot be null
defined in: JsonLead
string
An array of URLs with information related to the sale
related_urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Custom fields for the sale
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
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
string
The username assigned to the appraisal
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The appraisal state
status
is optional
Type: string
cannot be null
defined in: JsonLead
string
The car associated with this appraisal
car
object
(Car)
The car associated with this appraisal
origin
object
(Origin)
The type of the lead
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
The location of the appraisal
dealer_location
is optional
Type: string
cannot be null
defined in: JsonLead
string
The appraised value for the car
appraisal_value
is optional
Type: number
cannot be null
defined in: JsonLead
number
A task object to associate with the appraisal
task
object
(Task)
An offer object to associate with the sale
offer
object
(Offer)
An appointment object to associate with the appraisal
appointment
is optional
Type: object
(Appointment)
cannot be null
defined in: JsonLead
object
(Appointment)
The comment contents
comment
is optional
Type: string
cannot be null
defined in: JsonLead
string
An array of URLs with information related to the appraisal
related_urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Custom fields for the appraisal
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
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 |
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
is optional
Type: string
cannot be null
defined in: JsonLead
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"new" |
|
"used" |
The vehicle category
category
is optional
Type: string
cannot be null
defined in: JsonLead
string
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"car" |
|
"motorcycle" |
|
"industrial" |
An unique identifier for the car
stock_id
is optional
Type: string
cannot be null
defined in: JsonLead
string
Body type
body_style
is optional
Type: string
cannot be null
defined in: JsonLead
string
Make
make
is optional
Type: string
cannot be null
defined in: JsonLead
string
Model
model
is optional
Type: string
cannot be null
defined in: JsonLead
string
version
is optional
Type: string
cannot be null
defined in: JsonLead
string
Fabrication year
year
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Fabrication month
month
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Price
price
is optional
Type: number
cannot be null
defined in: JsonLead
number
License place
license_plate
is optional
Type: string
cannot be null
defined in: JsonLead
string
Mileage
mileage
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Number of doors
doors
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Duration of the warranty in months
warranty_months
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Vehicle Identification Number
vin
is optional
Type: string
cannot be null
defined in: JsonLead
string
Fuel Type
fuel
is optional
Type: string
cannot be null
defined in: JsonLead
string
Transmission Type
transmission
is optional
Type: string
cannot be null
defined in: JsonLead
string
Horsepower
horsepower
is optional
Type: number
cannot be null
defined in: JsonLead
number
minimum: the value of this number must greater than or equal to: 0
Color
color
is optional
Type: string
cannot be null
defined in: JsonLead
string
Car publication URL
url
is optional
Type: string
cannot be null
defined in: JsonLead
string
URI: the string must be a URI, according to RFC 3986
Car's images' URLs
image_urls
is optional
Type: string[]
cannot be null
defined in: JsonLead
string[]
Engine volume (cc3)
engine_size
is optional
Type: number
cannot be null
defined in: JsonLead
number
Extras
equipment
is optional
Type: string
cannot be null
defined in: JsonLead
string
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.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 |
The source of the lead
source
is optional
Type: string
cannot be null
defined in: JsonLead
string
The medium of the lead
medium
is optional
Type: string
cannot be null
defined in: JsonLead
string
The campaign of the lead
campaign
is optional
Type: string
cannot be null
defined in: JsonLead
string
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
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
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The user assigned to this task
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
The task description
description
is optional
Type: string
cannot be null
defined in: JsonLead
string
Custom fields for the task
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
The offered amount, in the local currency
amount
is optional
Type: number
cannot be null
defined in: JsonLead
number
The description of the offer
description
is optional
Type: string
cannot be null
defined in: JsonLead
string
The creation date of the offer. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
date
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The type of the offer
type
is optional
Type: string
cannot be null
defined in: JsonLead
string
Custom fields for the offer
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.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 |
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
string
The date of the appointment. Should follow ISO 8601 (2024-02-06T15:26:17.683Z)
due_date
is optional
Type: string
cannot be null
defined in: JsonLead
string
date time: the string must be a date time string, according to RFC 3339, section 5.6
The user assigned to the appointment
assigned_to
is optional
Type: string
cannot be null
defined in: JsonLead
string
Custom fields for the appointment
custom
object
(Details)
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/JSONLead/jsonlead/master/schemas/jsonlead_v1.0.0.schema.json#/definitions/comment"}
Property | Type | Required | Nullable | Defined by |
---|