Create reward

post

https://api.getkivly.com/api/v1/rewards/

Creates a reward.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

Reward title

description

string

required

Reward description

reward_type

string

enum

required

Type of reward

Allowed:

value

number

required

Reward value (percentage, amount, etc.)

points_required

integer

required

Points required to redeem

point_type

string

enum

Defaults to POINT

Type of points required

Allowed:

image

Reward image URL

terms_and_conditions

Terms and conditions

max_redemptions

Maximum number of redemptions allowed

valid_from

When the reward becomes valid

valid_until

When the reward expires

product_discount_apply_to

first | all | most_expensive | cheapest

product_discount_max_items

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Create reward succeeded.

401Authentication credentials were missing, invalid, or expired.

403The authenticated integration does not have access to this resource.

422Validation Error

429Too many requests. Retry after the period indicated by the API.

500Unexpected server error.