API Reference

Create new reward

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

Create a new reward for the authenticated user's business

Integration access is restricted to the credential's location. Pagination, monetary units and response envelopes are endpoint-specific; use the schema below. Do not assume that POST/PATCH requests are safe to retry after a timeout.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Reward creation request model

string
required

Reward title

string
required

Reward description

string
enum
required

Type of reward

Allowed:
number
required

Reward value (percentage, amount, etc.)

integer
required
≥ 0

Points required to redeem

string
enum
Defaults to POINT

Type of points required

Allowed:

Reward image URL

Terms and conditions

Maximum number of redemptions allowed

When the reward becomes valid

When the reward expires

CouponType | null
Defaults to percentage
array | null
Combination | null
ProductDiscountApplyTo | null

first | all | most_expensive | cheapest

Máximo de items (null = sin límite)

AllowedOrderTypes | null
RewardAssignmentMode | null
Defaults to DIRECT
RewardExpirationAnchor | null
Defaults to REWARD_VALID_UNTIL
customerIds
array of strings
Customerids
customerSegmentIds
array of strings
Customersegmentids
array | null
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?