Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Expand
titlelead 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

Tip

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:

Include Page
notification_identifier
notification_identifier

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

Tip

Deprecated from R17.0.0


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:

Include Page
communication_identifier
communication_identifier

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:

Include Page
contact_information_identifier
contact_information_identifier

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

Tip

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:

Include Page
user_identifier
user_identifier

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

Tip

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:

Include Page
contact_information_identifier
contact_information_identifier

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

Tip

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