HomeAPI ReferenceGuides
API Reference

Create a new Reward.

post
https://api.ottolearn.io/v1/rest/reward

Create a new Reward that can be redeemed by Learners in the Reward Store. A Reward can non-serialized for items with basic quantities, or serialized to keep track of unique items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
Defaults to active
Allowed:
string
int32
≥ 1
int32
required
≥ 1
boolean
required

Sets the type of Reward to create (serialized or non-serialized). Note: This value cannot be changed after creation.

int32
≤ 99999

Sets the quantity for non-serialized Rewards only. Serialized Rewards must define items instead.

items
array of objects
items
contents
array of objects
required
length ≥ 1
contents*
string
required
length ≤ 255
string | null
required
string
required
string
enum
Defaults to active
Allowed:
int32
required
≥ 1
Responses

Updated over 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago