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": {}
}
'

import requests

url = "https://api.scrip.dev/v1/programs/{programId}/rewards"

payload = {
    "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": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {}
  })
};

fetch('https://api.scrip.dev/v1/programs/{programId}/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrip.dev/v1/programs/{programId}/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrip.dev/v1/programs/{programId}/rewards"

	payload := strings.NewReader("{\n  \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"$10 Gift Card\",\n  \"redemption_type\": \"UNIT_BASED\",\n  \"status\": \"DRAFT\",\n  \"unit_cost\": \"1000.00\",\n  \"available_from\": \"2024-01-01T00:00:00Z\",\n  \"available_until\": \"2024-12-31T23:59:59Z\",\n  \"category\": \"Gift Cards\",\n  \"description\": \"Redeemable for a $10 gift card\",\n  \"max_per_participant\": 2,\n  \"max_total\": 100,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scrip.dev/v1/programs/{programId}/rewards")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"$10 Gift Card\",\n  \"redemption_type\": \"UNIT_BASED\",\n  \"status\": \"DRAFT\",\n  \"unit_cost\": \"1000.00\",\n  \"available_from\": \"2024-01-01T00:00:00Z\",\n  \"available_until\": \"2024-12-31T23:59:59Z\",\n  \"category\": \"Gift Cards\",\n  \"description\": \"Redeemable for a $10 gift card\",\n  \"max_per_participant\": 2,\n  \"max_total\": 100,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/programs/{programId}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"$10 Gift Card\",\n  \"redemption_type\": \"UNIT_BASED\",\n  \"status\": \"DRAFT\",\n  \"unit_cost\": \"1000.00\",\n  \"available_from\": \"2024-01-01T00:00:00Z\",\n  \"available_until\": \"2024-12-31T23:59:59Z\",\n  \"category\": \"Gift Cards\",\n  \"description\": \"Redeemable for a $10 gift card\",\n  \"max_per_participant\": 2,\n  \"max_total\": 100,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "asset_id": "550e8400-e29b-41d4-a716-446655440002",
  "available_from": "2024-01-01T00:00:00Z",
  "available_until": "2024-12-31T23:59:59Z",
  "category": "Gift Cards",
  "committed_units": 42,
  "created_at": "2024-01-15T10:30:00Z",
  "delivered_units": 39,
  "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",
  "pending_units": 3,
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "redemption_type": "UNIT_BASED",
  "status": "ACTIVE",
  "unit_cost": "1000.00",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "code": "bad_request",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Invalid request parameters"
}

{
  "code": "unauthorized",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Missing or invalid credentials"
}

{
  "code": "not_found",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource not found"
}

{
  "code": "conflict",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource already exists or state conflict"
}

{
  "code": "unsupported_media_type",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Content-Type must be application/json"
}

{
  "code": "internal_error",
  "message": "An internal error occurred"
}

POST

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": {}
}
'

import requests

url = "https://api.scrip.dev/v1/programs/{programId}/rewards"

payload = {
    "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": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {}
  })
};

fetch('https://api.scrip.dev/v1/programs/{programId}/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrip.dev/v1/programs/{programId}/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrip.dev/v1/programs/{programId}/rewards"

	payload := strings.NewReader("{\n  \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"$10 Gift Card\",\n  \"redemption_type\": \"UNIT_BASED\",\n  \"status\": \"DRAFT\",\n  \"unit_cost\": \"1000.00\",\n  \"available_from\": \"2024-01-01T00:00:00Z\",\n  \"available_until\": \"2024-12-31T23:59:59Z\",\n  \"category\": \"Gift Cards\",\n  \"description\": \"Redeemable for a $10 gift card\",\n  \"max_per_participant\": 2,\n  \"max_total\": 100,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scrip.dev/v1/programs/{programId}/rewards")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"$10 Gift Card\",\n  \"redemption_type\": \"UNIT_BASED\",\n  \"status\": \"DRAFT\",\n  \"unit_cost\": \"1000.00\",\n  \"available_from\": \"2024-01-01T00:00:00Z\",\n  \"available_until\": \"2024-12-31T23:59:59Z\",\n  \"category\": \"Gift Cards\",\n  \"description\": \"Redeemable for a $10 gift card\",\n  \"max_per_participant\": 2,\n  \"max_total\": 100,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/programs/{programId}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"$10 Gift Card\",\n  \"redemption_type\": \"UNIT_BASED\",\n  \"status\": \"DRAFT\",\n  \"unit_cost\": \"1000.00\",\n  \"available_from\": \"2024-01-01T00:00:00Z\",\n  \"available_until\": \"2024-12-31T23:59:59Z\",\n  \"category\": \"Gift Cards\",\n  \"description\": \"Redeemable for a $10 gift card\",\n  \"max_per_participant\": 2,\n  \"max_total\": 100,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "asset_id": "550e8400-e29b-41d4-a716-446655440002",
  "available_from": "2024-01-01T00:00:00Z",
  "available_until": "2024-12-31T23:59:59Z",
  "category": "Gift Cards",
  "committed_units": 42,
  "created_at": "2024-01-15T10:30:00Z",
  "delivered_units": 39,
  "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",
  "pending_units": 3,
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "redemption_type": "UNIT_BASED",
  "status": "ACTIVE",
  "unit_cost": "1000.00",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "code": "bad_request",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Invalid request parameters"
}

{
  "code": "unauthorized",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Missing or invalid credentials"
}

{
  "code": "not_found",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource not found"
}

{
  "code": "conflict",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource already exists or state conflict"
}

{
  "code": "unsupported_media_type",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Content-Type must be application/json"
}

{
  "code": "internal_error",
  "message": "An internal error occurred"
}

Creates a new reward in a program’s catalog. A reward requires a name, redemption_type, asset_id, unit_cost, and status. You can also include description, category, and a freeform metadata object. The asset_id must reference an asset that is linked to the program. unit_cost must be a positive decimal string. Both redemption_type and asset_id are immutable after creation. 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. Set available_from and available_until to define a redemption window (available_from must be before available_until). Most rewards should start in DRAFT status until configuration is finalized, then transition to ACTIVE when ready. Reward names must be unique within a program. A 409 is returned with code name_exists if the name is already taken. Rewards cannot be created in archived programs.

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"

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"

Scrip API

Endpoints

Create a reward

Authorizations

Path Parameters

Body

Response