Redeem rewards

Redeems multiple rewards with the specified IDs. This operation is used to make a user redeem rewards.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Reward ID

Query Params

userId

string <uuid>

required

rewardIds

array[string <uuid>]

required

comma-separated IDs of the rewards to be redeemed.

tokenId

number

optional

ID of the collectible to be redeemed.

Header Params

Origin

string

required

The value must be one of the whitelisted domains. You can whitelist domain URLs on your Loyi dashboard.

Default:

<WHITELISTED_URL>

Example:

https://example.com

Responses

🟢200OK

application/json

Body

rewards

array[null (Reward) {3}]

optional

object

CouponLinkUnique

optional

Example:

{"id":"123e4567-e89b-12d3-a456-426655440000","code":null,"title":"Unique Coupon","description":"A special reward with unique coupons","instruction":"Use these coupons to get discounts","type":"CouponLinkUnique","link":"https://example.com","coupons":[{"code":"coupon1"},{"code":"coupon2"}],"createdAt":"2022-01-01T00:00:00.000Z","updatedAt":"2022-01-01T00:00:00.000Z"}

object

CouponLinkGeneric

optional

Example:

{"id":"123e4567-e89b-12d3-a456-426655440000","code":"GENERICCODE123","title":"Generic Coupon","description":"A general reward with a coupon code","instruction":"Use this coupon to get a discount","type":"CouponLinkGeneric","link":"https://example.com","createdAt":"2022-01-01T00:00:00.000Z","updatedAt":"2022-01-01T00:00:00.000Z"}

object

EntryPass

optional

Example:

{"id":"123e4567-e89b-12d3-a456-426655440000","title":"Event Entry Pass","description":"An entry pass for the event","instruction":"Show this pass at the event entrance","type":"EntryPass","createdAt":"2022-01-01T00:00:00.000Z","updatedAt":"2022-01-01T00:00:00.000Z"}

errors

array [object {2}]

optional

resourceId

string <uuid>

optional

ID of the reward.

message

string

optional

Error message.

Example

{
    "rewards": [
        {
            "id": "123e4567-e89b-12d3-a456-426655440000",
            "title": "Event Entry Pass",
            "description": "An entry pass for the event",
            "instruction": "Show this pass at the event entrance",
            "type": "EntryPass",
            "createdAt": "2022-01-01T00:00:00.000Z",
            "updatedAt": "2022-01-01T00:00:00.000Z"
        }
    ],
    "errors": [
        {
            "resourceId": "123e4567-e89b-12d3-a456-426655440000",
            "message": "You are not eligible to redeem this reward."
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request

Request samples

Responses