Partner Programs: Required Attributes and Path Parameters

This section lists the required attributes and path elements for the Request payloads of the Partner Programs resource and its child resources.

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

Parent Level

Partner Programs

Child Resources

ProgramBenefitDetails

PartnerProgramCountries

ProgramTiers

The following table lists the attributes required for the POST method for Partner Programs resource.

Resources Attribute Attribute Description

Partner Programs

ProgramName

The name of the partner program.

ProgramType

Indicates the type of the partner program. The accepted values are reseller and go to market.

The list of values for program types is available in ProgramTypes.

The following table lists the attributes required for the POST method for Partner Programs child resources.

Child Resource Attribute Attribute Description

Partner Programs > Program Benefit Details

ProgramBenefitId

The unique identifier of the program benefit.

Partner Programs > Partner Program Countries

CountryCode

The country code to which the partner program applies.

Partner Programs > Program Tiers

TierId

The unique identifier of the Tier which is being added to the program.

The following table lists the path parameters required for the PATCH method for Partner Programs resource.

Resources Path Path Parameters

Partner Programs

/crmRestApi/resources/11.13.18.10/partnerPrograms/{ProgramNumber}

ProgramNumber

The following table lists the path parameters required for the PATCH method for Partner Programs child resources.

Child Resource Path Path Parameters

Partner Programs > Program Benefit Details

/crmRestApi/resources/11.13.18.10/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitId}

ProgramNumber

ProgramBenefitId

Partner Programs > Partner Program Countries

/crmRestApi/resources/11.13.18.10/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}

ProgramNumber

ProgramCountryId

Partner Programs > Program Tiers

/crmRestApi/resources/11.13.18.10/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{TierId}

ProgramNumber

TierId