This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

lead


This is object used to describe the lead details for azure blob data migration

No Additional Properties

Type: object

The following properties are required:

  • contact
Type: object

The following properties are required:

  • company

Type: string

OpCo's lead number or id that identifies the record.

Must be at least 1 characters long

Must be at most 100 characters long


Example:

"1234567"

Type: string

Descriptive name for the lead

Must be at least 1 characters long

Must be at most 300 characters long


Example:

"Client has started on a new project."

Type: string

Type additional information to describe the lead, such as an excerpt from the company's website..

Must be at most 2000 characters long

Type: object
No Additional Properties

Type: string

Type the name of the company associated with the lead. This becomes the account name when the lead is qualified and converted to a customer account.


Example:

"Earth Live and Neutraul"

Type: string

registration ID of the company within its country, like siret number in France.


Example:

"12356894100056"

Type: string

VAT Number.

Must be at most 20 characters long

Address

Type: object

A commun definition of an address

No Additional Properties

Type: string

According to ISO 19060, this field contains one third of the address. In most cases this usually contains the whole addres though.

Must be at least 1 characters long


Example:

"Belleboslaan 17"

Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

Type: string

City.

Must be at least 1 characters long


Example:

"Montesson"

Type: string

The ISO 3166-1 alpha-3 of the country

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"FRA"

Type: string

Zip code.

Must be at least 1 characters long


Example:

"78360"

Type: string

department


Example:

"JURA"

Type: string

region


Example:

"Bretagne"

Type: integer

Type the number of employees that work at the company associated with the lead, for use in marketing segmentation and demographic analysis.

Value must be greater or equal to 0 and lesser or equal to 1000000

Type: integer

The number of field technicians.

Value must be greater or equal to 0 and lesser or equal to 2147483647

Type: string

Type the website URL for the company associated with this lead.

Must be at most 200 characters long

Type: string

The phone number of the company conforming to the ITU-T E.164 international public telecommunication numbering plan..

Must be at most 100 characters long


No Additional Properties

Type: object

The following properties are required:

  • email
Type: object

The following properties are required:

  • mobilePhone
Type: object

The following properties are required:

  • landlinePhoneNumber

Type: string

Type the first name of the primary contact for the lead to make sure the prospect is addressed correctly in sales calls, email, and marketing campaigns.

Must be at least 1 characters long

Must be at most 50 characters long

Type: string

Type the last name of the primary contact for the lead to make sure the prospect is addressed correctly in sales calls, email, and marketing campaigns.

Must be at most 50 characters long

Type: stringFormat: email

Type the primary email address for the lead.

Must be at least 1 characters long

Must be at most 100 characters long

Type: string

Type the mobile phone number for the primary contact for the lead conforming to the ITU-T E.164 international public telecommunication numbering plan.

Must be at least 1 characters long

Must be at most 20 characters long

Type: string

Type the landline phone number for the primary contact for the lead conforming to the ITU-T E.164 international public telecommunication numbering plan. This phone number will not receive SMS.

Must be at least 1 characters long

Must be at most 20 characters long

Type: string

Specify the Job Role for this Contact.

Type: stringFormat: date-time

Date and time when the record was created.


Examples:

"2021-10-12T08:30:22.804Z"
"2018-11-13T20:20:39+02:00"

Type: string

Choose an account to connect this lead to, so that the relationship is visible in reports and analytics. It must match an opcoAccountId of account data model (account.opcoAccountId). Only customer accounts are allowed


Examples:

"1234567"
"1234567_OVIA"

Type: string

Choose an contact to connect this lead to, so that the relationship is visible in reports and analytics. It must match an opcoContactId of contact data model (contact.opcoContactId). Can be either CRM legacy Id or ERP Id


Example:

"12345678"

Default: [true]

Select whether the contact accepts bulk sms sent through marketing campaigns or quick campaigns. If Do Not Allow is selected, the contact can be added to marketing lists, but will be excluded from the sms.

Type: const

Do Not Allow

Specific value: true
Type: const

Allow

Specific value: false

Example:

true

Default: [true]

Select whether the contact accepts bulk email sent through marketing campaigns or quick campaigns. If Do Not Allow is selected, the contact can be added to marketing lists, but will be excluded from the email.

Type: const

Do Not Allow

Specific value: true
Type: const

Allow

Specific value: false

Example:

true

Default: "231820000"

Select the primary marketing source that prompted the lead to contact you.

Type: const

Advertisement

Specific value: "1"
Type: const

Employee Referral

Specific value: "2"
Type: const

External Referral

Specific value: "3"
Type: const

Partner

Specific value: "4"
Type: const

Public Relations

Specific value: "5"
Type: const

Seminar

Specific value: "6"
Type: const

Trade Show

Specific value: "7"
Type: const

Web

Specific value: "8"
Type: const

Word of Mouth

Specific value: "9"
Type: const

Other

Specific value: "10"
Type: const

LinkedIn Sponsored Form

Specific value: "192350000"
Type: const

Landing page

Specific value: "192350100"
Type: const

Associate

Specific value: "231820000"

Must be at most 20 characters long


Example:

"231820000"

Type: string

A facility id with capability SERVICE_CENTER.
A service center is the entity to represent the Sonepar venue in charge of managing the customer relationships for any physical touch point regarding sales or services aspects.
Can be represented by a Sonepar Branch for Small or Middle size account or by a Hub for larger accounts.
Then, in some cases, this service center can be different from the default facility id already provided in account feed.

Must be at most 50 characters long


Example:

"4335"

Type: string

Type the Standard Industrial Classification (SIC) code that indicates the lead's primary industry of business for use in marketing segmentation and demographic analysis.

Must be at most 20 characters long

Type: stringFormat: email

Enter the email address of the user who is assigned to manage the record.

Must be at most 254 characters long

Default: ["1"]

The status reason of the Lead.

Type: const

New

Specific value: "1"
Type: const

Contacted

Specific value: "2"
Type: const

Lost

Specific value: "4"
Type: const

Cannot Contact

Specific value: "5"
Type: const

No Longer Interested

Specific value: "6"
Type: const

Canceled

Specific value: "7"

Must be at least 1 characters long

Must be at most 1 characters long


Example:

"1"