GET
/
v1
/
coupons
/
activate

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

This API will redirect your users to the retailer’s website automatically and activate the coupon offer.

How to use

This API should be called every time your user wants to activate a coupon offer. The API will return a URL or automatically handle redirects so 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.

Since this API is a GET request, you can use it to redirect your user to the retailer’s website directly.

First party URL vs Sleek API URL

Users click coupon offers links more often if the link is to your domain, due to trust and simplicity in the activation experience.

Consider putting your applications URL in front of the Sleek API URL to give your customers a seamless experience. For example:

https://yourapp.com/sleek-redirect/?couponId=b2ad0802-e632-4edd-b074-8112e3d065c5&passbackUid=b3dms0-10ib3ka&orgId=AS24DFVADS1234`.

Then, your application would have a route that would redirect to the Sleek API URL.

Steps

1

Determine the coupon offer

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

2

Activate coupon offer

Send the URL to the URL detailed here with your desired couponId, 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 coupon offer activates.

3

Redirect the user

The API will automatically redirect the user to the retailer’s website with the activated coupon offer.

Coupon offer activated

After the URL redirect is complete, the coupon 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

couponId
string
required

The ID of the coupon to activate. 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 coupon affiliate

Response

302 - application/json

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