Create reward

Staging

https://testserver.loyi.io/public/api

POST

/reward

Reward

Creates and returns a reward.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

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

Body Params application/json

optional

One of

CreateCouponLinkUniqueBody

CreateCouponLinkGenericBody

CreateEntryPassBody

Example:

{"title":"Unique Coupon","description":"A special reward with unique coupons","instruction":"Use these coupons to get discounts","link":"https://example.com","type":"CouponLinkUnique","coupons":["coupon1","coupon2"]}

title

string

required

Title of the reward.

description

string

required

Description of the reward.

instruction

string

required

Instruction text of the reward.

link

string <uri>

required

Link of the reward.

type

enum<string>

required

Allowed value:

CouponLinkUnique

coupons

array[string]

required

An array of unique coupon codes.

Example

{
    "title": "Unique Coupon",
    "description": "A special reward with unique coupons",
    "instruction": "Use these coupons to get discounts",
    "link": "https://example.com",
    "type": "CouponLinkUnique",
    "coupons": [
        "coupon1",
        "coupon2"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://testserver.loyi.io/public/api/reward' \
--header 'Origin;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "title": "Unique Coupon",
    "description": "A special reward with unique coupons",
    "instruction": "Use these coupons to get discounts",
    "link": "https://example.com",
    "type": "CouponLinkUnique",
    "coupons": [
        "coupon1",
        "coupon2"
    ]
}'

Responses

🟢201Created

application/json

Created

Body

Reward

optional

One of

CouponLinkUnique

CouponLinkGeneric

EntryPass

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"}

title

string

required

Title of the reward.

description

string

required

Description of the reward.

instruction

string

required

Instruction text of the reward.

link

string <uri>

required

Link of the reward.

string <uuid>

required

type

enum<string>

required

Allowed value:

CouponLinkUnique

coupons

array [object {1}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

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"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-19 21:23:41

Rewards Overview

Get rewards