POST
/
v1
/
promotions
/
activate

Promotion offer activation is how your users can earn cashback and rewards from Sleek’s promotion offers.

How to use

This API should be called every time your user wants to activate a promotion offer. The API will return a URL that your user can visit to complete the activation process.

This API is unauthenticated and expected to be called on the client side from your user’s devices.

1

Determine the promotion offer

Find the promotion offer that the user wants to activate. For example, the user might want to activate promotion at Walmart with promotionId equal to 3b85b29d-d167-41ad-9cde-8507f5cc5fbc.

2

Activate promotion offer

Call the API endpoint detailed here with your desired promotionId, your activation orgId, and a passbackUid that uniquely identifies this user or some reference that you will track. Optionally, use the passbackData param to store any data about this activation that you’d like tracked with any transaction that occurs from the user after this promotion offer activates.

3

Redirect the user

After the POST request, the API will return a URL that your user should visit. This URL will route the user to the target retailer’s website and handle activating the promotion offer.

Promotion offer activated

After the URL redirect is complete, the offer has been activated. Your user can now shop at the retailer and earn cashback or rewards. Any rewards earned will be tracked in the Sleek transaction API.

Query Parameters

promotionId
string
required

The ID of the promotion. Format: UUID RFC 4122

passbackUid
string
required

A unique identifier for this activation. This will be passed back to you when a transaction occurs. Format: any string

passbackData
string

Any data you want to pass back to you when a transaction occurs. Format: any string

orgId
string
required

Your organization's UID for activating retailer's promotion affiliate

Response

200 - application/json

The URL to redirect the user to activate the retailer's promotion affiliate.