Skip to main content
POST
/
v1
/
programs
/
{programId}
/
rewards
Create a reward
curl --request POST \
  --url https://api.scrip.dev/v1/programs/{programId}/rewards \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "asset_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "$10 Gift Card",
  "redemption_type": "UNIT_BASED",
  "status": "DRAFT",
  "unit_cost": "1000.00",
  "available_from": "2024-01-01T00:00:00Z",
  "available_until": "2024-12-31T23:59:59Z",
  "category": "Gift Cards",
  "description": "Redeemable for a $10 gift card",
  "max_per_participant": 2,
  "max_total": 100,
  "metadata": {}
}
'
{
  "asset_id": "550e8400-e29b-41d4-a716-446655440002",
  "available_from": "2024-01-01T00:00:00Z",
  "available_until": "2024-12-31T23:59:59Z",
  "category": "Gift Cards",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Redeemable for a $10 gift card",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "max_per_participant": 2,
  "max_total": 100,
  "metadata": {},
  "name": "$10 Gift Card",
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "redeemed_count": 42,
  "redemption_type": "UNIT_BASED",
  "status": "ACTIVE",
  "unit_cost": "1000.00",
  "updated_at": "2024-01-15T10:30:00Z"
}
Creates a new reward in a program’s catalog. A reward requires a name, redemption_type, asset_id, unit_cost, and status. redemption_type controls how participants redeem: UNIT_BASED rewards are redeemed in discrete quantities with optional inventory caps (max_total, max_per_participant), while AMOUNT_BASED rewards allow variable amounts with no inventory limits. Both redemption_type and asset_id are immutable after creation. Set available_from and available_until to define a redemption window. Most rewards should start in DRAFT status until configuration is finalized, then transition to ACTIVE when ready.
For usage patterns and examples, see the Rewards Catalog guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
programId
string<uuid>
required

Program ID

Body

application/json

Reward details

​
asset_id
string<uuid>
required

Asset used to price this reward (must be linked to the program). Immutable after creation.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string
required

Display name for the reward

Required string length: 1 - 255
Example:

"$10 Gift Card"

​
redemption_type
enum<string>
required

How the reward is redeemed: UNIT_BASED (discrete quantities) or AMOUNT_BASED (variable amounts). Immutable after creation.

Available options:
UNIT_BASED,
AMOUNT_BASED
Example:

"UNIT_BASED"

​
status
enum<string>
required

Lifecycle status: DRAFT, ACTIVE, OUT_OF_STOCK, or ARCHIVED

Available options:
DRAFT,
ACTIVE,
OUT_OF_STOCK,
ARCHIVED
Example:

"DRAFT"

​
unit_cost
string
required

Cost per unit in the reward's asset (decimal string for precision, must be positive)

Minimum string length: 1
Example:

"1000.00"

​
available_from
string<date-time>

Start of the availability window (RFC 3339, null if always available)

Example:

"2024-01-01T00:00:00Z"

​
available_until
string<date-time>

End of the availability window (RFC 3339, null if no end date)

Example:

"2024-12-31T23:59:59Z"

​
category
string

Grouping label for organizing rewards in the catalog

Maximum string length: 100
Example:

"Gift Cards"

​
description
string

Details about the reward

Maximum string length: 1000
Example:

"Redeemable for a $10 gift card"

​
max_per_participant
integer

Per-participant redemption limit (UNIT_BASED only, null = unlimited)

Example:

2

​
max_total
integer

Global inventory limit (UNIT_BASED only, null = unlimited)

Example:

100

​
metadata
object

Custom key-value data attached to this reward

Response

Reward created

A reward with its pricing, inventory, availability, and metadata

​
asset_id
string<uuid>

Asset used to price this reward

Example:

"550e8400-e29b-41d4-a716-446655440002"

​
available_from
string<date-time>

Start of the availability window (RFC 3339, null if always available)

Example:

"2024-01-01T00:00:00Z"

​
available_until
string<date-time>

End of the availability window (RFC 3339, null if no end date)

Example:

"2024-12-31T23:59:59Z"

​
category
string

Grouping label for organizing rewards in the catalog

Example:

"Gift Cards"

​
created_at
string<date-time>

When this reward was created (RFC 3339)

Example:

"2024-01-15T10:30:00Z"

​
description
string

Details about the reward

Example:

"Redeemable for a $10 gift card"

​
id
string<uuid>

Unique identifier for this reward

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
max_per_participant
integer

Per-participant redemption limit (UNIT_BASED only, null = unlimited)

Example:

2

​
max_total
integer

Global inventory limit (UNIT_BASED only, null = unlimited)

Example:

100

​
metadata
object

Custom key-value data attached to this reward

​
name
string

Display name for this reward

Example:

"$10 Gift Card"

​
program_id
string<uuid>

Program this reward belongs to

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
redeemed_count
integer

Total number of times this reward has been redeemed

Example:

42

​
redemption_type
string

How the reward is redeemed: UNIT_BASED (discrete quantities) or AMOUNT_BASED (variable amounts)

Example:

"UNIT_BASED"

​
status
string

Lifecycle status: DRAFT, ACTIVE, OUT_OF_STOCK, or ARCHIVED

Example:

"ACTIVE"

​
unit_cost
string

Cost per unit in the reward's asset (decimal string for precision)

Example:

"1000.00"

​
updated_at
string<date-time>

When this reward was last modified (RFC 3339)

Example:

"2024-01-15T10:30:00Z"