Create a new rewardType

POST 
/rewardType

Create a new rewardType

Request

application/json

Body

Data for creating a new rewardType

id rewardTypeId (string)

Unique identifier for RewardType

data stringrequired

JSON string containing metadata, actions, and functions associated with the reward.

title stringrequired

Title of the reward type.

thumbnail stringnullable

URL of the thumbnail for the reward type.

name stringrequired

Name of the reward type.

category stringrequired

Category of the reward type.

singleUse boolean

Boolean to specify if the rewardType can reeemed once.

description string

Detailed description of the reward type.

Responses

201

rewardType successfully created

application/json

Schema

Schema

id rewardTypeId (string)

Unique identifier for RewardType

data stringrequired

JSON string containing metadata, actions, and functions associated with the reward.

title stringrequired

Title of the reward type.

createdAt date-time

The date and time when the reward type was created.

thumbnail stringnullable

URL of the thumbnail for the reward type.

name stringrequired

Name of the reward type.

category stringrequired

Category of the reward type.

singleUse boolean

Boolean to specify if the rewardType can reeemed once.

description string

Detailed description of the reward type.

Example (from schema)

{
  "id": "R3b19Z1n",
  "data": "{\"validity\": \"30 days\", \"features\": [\"no ads\", \"exclusive content\"]}",
  "title": "One Month Premium Subscription",
  "createdAt": "2023-10-23T10:00:00Z",
  "thumbnail": "https://example.com/thumbnail.png",
  "name": "Premium Subscription",
  "category": "Digital Goods",
  "singleUse": "true",
  "description": "This reward gives you access to premium features for one month."
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...