Add Lead

Adds a new lead. A new non-loyalty customer will be created if you pass a new customer identifier.

Request Body Parameters

ParameterData typeDescription
typeenumItem or hierarchy for which the lead is generated. Values: SKU, BRAND, CATEGORY, or CUSTOM. Default value is SKU
leadFor*stringName of SKU, brand or category based on the type specified
userIdintUnique id of the customer associated to the lead. If this is left blank, then you need to pass idType and identifier as mandatory parameters
idTypeenumSpecified identifier type either EMAIL or MOBILE
identifierstringValue of the specified idType
nextFollowUpdateNext follow up date of the lead
createdOndate-timeDate and time of lead creation in YYYY-MM-DDThh:mm:ssTZD format. Example: 2018-10-05T08:00:00+05:30
createdByintEntity id of the staff who creates the lead.
Default value is the id of the entity from which the request has come
lastUpdatedOndate-timeDate and time when the lead is recently updated in YYYY-MM-DDThh:mm:ssTZD format
lastUpdatedByintEntity id of the staff who recently updated the lead
extendedFieldsobjKey-value pairs of extended fields and its values
orgSourceIdenumUnique id of the org channel account. Default value is -1 for InStore account
lastFollowUpDate and time of recent follow up of the lead in YYYY-MM-DDThh:mm:ssTZD format
ownerstringUsername of the staff user who is assigned to the lead
subStatusenumCurrent sub-status of the lead. Use only names that are created using leads/substatus API


To enable a specific language support for an org, contact the Platforms team to get the translations added to the database and activate translations for the org.

Click Try It! to start a request and see the response here!