v1

latestOpenAPI 3.1.02026-07-2631111195.5 KB
Promotions
Experimental

Create a promotion enrollment

Enrolls an account into an existing promotion.

Endpoint available to Partners only. The request must be authenticated by an access token that the user has granted to the Partner for the account.

The enrollment_id, returned after successfully enrolling a user, must be stored by the partner in order to retrieve or delete the enrollment.

OAuth

This endpoint requires the promotions:write OAuth scope.

post/v2/promotions

Request body

promotion_idstring required

The unique identifier for the promotions

Response

Successful Enrollment

enrollment_idstring required

The unique identifier for the enrollment. This must be stored by partners.