Skip to main content
PATCH
/
v1
/
programs
/
{programId}
/
rewards
/
{rewardId}
Update a reward
curl --request PATCH \
  --url https://api.scrip.dev/v1/programs/{programId}/rewards/{rewardId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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": {},
  "name": "$10 Gift Card",
  "status": "ACTIVE",
  "unit_cost": "1000.00"
}
'
import requests

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

payload = {
    "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": {},
    "name": "$10 Gift Card",
    "status": "ACTIVE",
    "unit_cost": "1000.00"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {},
    name: '$10 Gift Card',
    status: 'ACTIVE',
    unit_cost: '1000.00'
  })
};

fetch('https://api.scrip.dev/v1/programs/{programId}/rewards/{rewardId}', 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/{rewardId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ],
    'name' => '$10 Gift Card',
    'status' => 'ACTIVE',
    'unit_cost' => '1000.00'
  ]),
  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/{rewardId}"

	payload := strings.NewReader("{\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  \"name\": \"$10 Gift Card\",\n  \"status\": \"ACTIVE\",\n  \"unit_cost\": \"1000.00\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.scrip.dev/v1/programs/{programId}/rewards/{rewardId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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  \"name\": \"$10 Gift Card\",\n  \"status\": \"ACTIVE\",\n  \"unit_cost\": \"1000.00\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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  \"name\": \"$10 Gift Card\",\n  \"status\": \"ACTIVE\",\n  \"unit_cost\": \"1000.00\"\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",
  "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"
}
{
  "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"
}
Updates a reward’s configuration. Only the fields included in the request body are changed; omitted fields remain as-is. You can modify name, description, category, unit_cost, max_total, max_per_participant, status, available_from, available_until, and metadata. The redemption_type and asset_id fields are immutable and cannot be updated. Reward names must be unique within a program. A 409 is returned with code name_exists if the name conflicts with another reward. To archive a reward, set status to ARCHIVED.
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

​
rewardId
string<uuid>
required

Reward ID

Body

application/json

Reward updates

​
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

​
name
string

Display name for the reward

Required string length: 1 - 255
Example:

"$10 Gift Card"

​
status
enum<string>

Lifecycle status: DRAFT, ACTIVE, OUT_OF_STOCK, or ARCHIVED

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

"ACTIVE"

​
unit_cost
string

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

Example:

"1000.00"

Response

Reward updated

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"