Partners: Required Attributes and Path Parameters
This section lists the required attributes and path parameters for the request payloads of the Partners resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
Parent Level |
Partners |
Child Resources |
Geographies |
Industries |
|
ProductSpecialities (Focus Areas) |
|
Types |
|
Certifications |
|
Expertise |
|
AccountTeamMembers |
|
Notes |
|
Contacts |
|
Contacts > User Account Details |
The following table lists the attributes required for the POST method for Partners resource.
Resource | Attribute | Attribute Description |
---|---|---|
Partners |
OrganizationName |
The name of the partner. |
AddressLineOne |
The first line for address. |
|
Country |
The country code of the address. The list of values for countries is available in CountryLookup. |
The following table lists the attributes required for the POST method for Partners child resources.
Resource | Attribute | Attribute Description |
---|---|---|
Partners > Geographies |
GeographyName |
The name of the geography served. |
Partners > Industries |
ClassificationName |
The classification name of the industry served. |
Partners > Product Specialities (Focus Areas) |
ProductName |
The product name of the product specialty. |
Partners > Types |
PartnerTypeName |
The partner type name, such as Value Added Reseller. |
Partners > Certifications |
CertificationCode |
The code of the certification. |
Partners > Expertise |
ExpertiseCode |
The expertise code of the partner expertise. |
Partners > Account Team Members |
ResourceId |
The unique identifier of the sale profile of the resource. |
Partners > Notes |
NoteTxt |
The actual note text. |
NoteTypeCode |
The code for categorization of the note type. The list of values for note type codes is available in the NoteSourceTypeVA. |
|
Partners > Contacts |
FirstName |
The first name of the person. |
LastName |
The last name of the person. |
|
EmailAddress |
The e-mail address of the partner contact. |
|
Partners > Contacts > User Account Details |
Username |
The user account name of partner contact |
The following table lists the path parameters required for the PATCH method for Partners resource.
Resource | Path | Path Parameters |
---|---|---|
Partners |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber} |
CompanyNumber |
The following table lists the path parameters required for the PATCH method for Partners child resources.
Resource | Path | Path Parameters |
---|---|---|
Partners > Geographies |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId} |
CompanyNumber PartnerDimMembersId |
Partners > Industries |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId} |
CompanyNumber PartnerDimMembersId |
Partners > Product Specialities (Focus Areas) |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId} |
CompanyNumber PartnerDimMembersId |
Partners > Types |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/types/{PartnerDimMembersId} |
CompanyNumber PartnerDimMembersId |
Partners > Certifications |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/certifications/{PartnerDimMembersId} |
CompanyNumber PartnerDimMembersId |
Partners > Expertise |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId} |
CompanyNumber PartnerMultivalLovId |
Partners > Account Team Members |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId} |
CompanyNumber PartnerAccountResourceId |
Partners > Notes |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/notes/{NoteId} |
CompanyNumber NoteId |
Partners > Contacts |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/contacts/{PartyId} |
CompanyNumber PartyId |
Partners > Contacts > User Account Details |
/crmRestApi/resources/11.13.18.10/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username} |
CompanyNumber PartyNumber Username |