Loading
Salesforce Enforces New Security Requirements in Summer 2026Read More
Learn About Real-Time Offer Management
Promotion Enrollment API

Promotion Enrollment API

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: EnterpriseUnlimited, and Developer Editions with Real-Time Offer 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.
 
Loading
Salesforce Help | Article