LoyaltyReward

Create a reward

Creates a new reward in the loyalty program.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID

Request

This endpoint expects an object.
namestringRequired<=128 characters
Internal name of the reward
publicDescriptionstringOptional<=128 characters
Public facing description of the reward
publicImagestringOptionalformat: "uri"
URL of the public image for the reward
publicNamestringOptional<=128 characters
Public facing name of the reward

Response

Reward successfully created
createdAtdatetime or null
Timestamp when the reward was created
idstring or nullformat: "uuid"
Unique identifier for the reward
loyaltyProgramIdstring or nullformat: "uuid"
Id of the loyalty program to which the current reward belongs to
namestring or null
Name of the reward
publicDescriptionstring or null
Public description for the reward
publicImagestring or null
Public Image for the reward
publicNamestring or null
Public name for the reward
updatedAtstring or null
Timestamp for when this reward was last updated.

Errors