Use the Promotion Enrollment API to enroll a customer in a promotion and create an
enrollment record. To provide a seamless experience, integrate this API with external systems such
as shopping sites and mobile apps that manage customer profiles.
Required Editions
Available in: Lightning Experience
Available in: Enterprise, Performance, Unlimited,
and Developer Editions with Loyalty Management
At the promotion level, the enrollment start and end dates define the overall eligibility
window for users. When you enroll a customer via Promotion Enrollment API using their
identifying details, such as a contact or account, the API validates that the enrollment request
occurs within the promotion's overall eligibility window. You can optionally provide the offer
ID that initiated the enrollment, along with customer-specific start and end dates that define
when the promotion applies to that specific customer. If you don't provide this start date and
end date, the system uses the date and time of the API call as the start date and the promotion
remains effective for the customer as long as the promotion is active, up until the promotion's
end date.
The API response provides these enrollment details:
Customer details, such as account or contact information.
Promotion details, such as the promotion ID or promotion code.
Promotion Party Usage ID, which is used to track the specific customer's enrollment.
Enrollment expiration date and time, provided only if it was included in the input.
Related offer details, provided only if it was included in the input.
Did this article solve your issue?
Let us know so we can improve!
Loading
Salesforce Help | Article
Cookie Consent Manager
General Information
Required Cookies
Functional Cookies
Advertising Cookies
General Information
We use three kinds of cookies on our websites: required, functional, and advertising. You can choose whether functional and advertising cookies apply. Click on the different cookie categories to find out more about each category and to change the default settings.
Privacy Statement
Required Cookies
Always Active
Required cookies are necessary for basic website functionality. Some examples include: session cookies needed to transmit the website, authentication cookies, and security cookies.
Functional Cookies
Functional cookies enhance functions, performance, and services on the website. Some examples include: cookies used to analyze site traffic, cookies used for market research, and cookies used to display advertising that is not directed to a particular individual.
Advertising Cookies
Advertising cookies track activity across websites in order to understand a viewer’s interests, and direct them specific marketing. Some examples include: cookies used for remarketing, or interest-based advertising.