Skip to end of banner
Go to start of banner

lead_source_parameters

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

 lead source parameter object data

Name

Type

Description

type

(mandatory)

String

The source type related with the lead. The allowed lead source type fields are the following: ADVERTISEMENT, NOTIFICATIONS, COMMUNICATIONS, RECOMMENDED_BY_CONTACT, RECOMMENDED_BY_EMPLOYEE,RECOMMENDED_BY_PARTNER, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3

name

(mandatory on conditions)

String

The source name related with the lead. The allowed lead source name is a free text and applies for the case that a source of type ADVERTISEMENT, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3

From R15.0.0, the name may be automatically provided if it was set up through the lead type.

source_notifications_identifier

(mandatory on conditions)

Notification Identifier

The notification related with the source of the lead. The allowed notification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification

number

(semi-optional)

String

The number of the notification

This information is mandatory and applicable if the type is set to NOTIFICATIONS

source_communications_identifier

(mandatory on conditions)

Communication Identifier

The communication related with the source of the lead. The allowed communication identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the communication

number

(semi-optional)

String

The number of the communicaiton

This information is mandatory and applicable if the type is set to COMMUNICATIONS

source_recommended_by_contact_identifier

(mandatory on conditions)

Contact Information Identifier

The contact information related with the source of the lead. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

This information is mandatory and applicable if the type is set to RECOMMENDED_BY_CONTACT

From R15.0.0, the contact may be automatically provided if it was set up through the lead type.


source_recommended_by_employee_identifier

(mandatory on conditions)

User Identifier

The user information related with the source of the lead. The allowed user identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

This information is mandatory and applicable if the type is set to RECOMMENDED_BY_EMPLOYEE

From R15.0.0, the user may be automatically provided if it was set up through the lead type.


source_recommended_by_partner_identifier

(mandatory on conditions)

Contact Information Identifier

The contact information representing the partner related with the source of the lead. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

This information is mandatory and applicable if the type is set to RECOMMENDED_BY_PARTNER

From R15.0.0, the contact may be automatically provided if it was set up through the lead type.


  • No labels