Sales Leads: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Sales Leads resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Sales Leads
Child Resources	Sales Lead Contacts
	Sales Lead Products
	Notes
	Sales Lead Resources
	Lead Qualifications
	Lead Qualifications > Assessment Answer Groups > Assessment Answers

The following table lists the attributes required for the POST method for Sales Leads resource.

Resource	Attribute	Attribute Description
Sales Leads	Name	Lead Name used for identifying the lead.

The following table lists the attributes required for the POST method for Sales Leads child resources.

Resource	Attribute	Attribute Description
Sales Leads > Sales Lead Contacts	PartyId	The unique identifier of the lead to which the contact is associated.
Sales Leads > Sales Lead Products	InventoryitemId	The unique inventory item identifier associated with the lead product.
Sales Leads > Notes	VisibilityCode	The unique identifier of the product group.
	SourceObjectCode	The code of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
	CurrencyCode	The currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
	CurcyConvRateType	The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
	NoteTypeCode	The code for categorization of the note type.
	CorpCurrencyCode	The corporate currency code of the note associated with the sales lead. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
	NoteTxt	The actual note text.
Sales Leads > Sales Lead Resources	ResourceId	The unique identifier associated with this sales lead resource.
Sales Leads > Lead Qualifications	AssessTemplateId	The name of the lead qualification template that served as the source of this qualification.

The following table lists the path parameters required for the PATCH method for Sales Leads resource.

Resource	Path	Path Parameters
Sales Lead	/crmRestApi/resources/11.13.18.10/leads/{LeadId}	LeadId

The following table lists the path parameters required for the PATCH method for Sales Leads child resources.

Resource	Path	Path Parameters
Sales Lead > Sales Lead Contacts	/crmRestApi/resources/11.13.18.10/leads/{LeadId}/child/MklLeadTcMembers1/{LeadMemberId}	LeadId LeadMemberId
Sales Lead > Sales Lead Products	/crmRestApi/resources/11.13.18.10/leads/{LeadId}/child/MklProdAssoc1/{LeadProductId}OrganizationId	LeadId LeadProductId
Sales Lead > Notes	/crmRestApi/resources/11.13.18.10/leads/{LeadId}/child/Note/{NoteId}	LeadId NoteId
Sales Lead > Sales Lead Resources	/crmRestApi/resources/11.13.18.10/leads/{LeadId}/child/MklLeadResources/{LeadResourceId}	LeadId LeadResourceId
Sales Leads > Lead Qualifications	/crmRestApi/resources/11.13.18.10/leads/{LeadId}/child/Assessments/{AssessmentId}	LeadId AssessmentId
Sales Leads > Lead Qualifications > Assessment Answer Groups > Assessment Answers	/crmRestApi/resources/11.13.18.10/leads/{LeadId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}	LeadId AssessmentId AssessAnswerGroupId AnswerId