---
title: "Update reward source"
method: PATCH
path: "/v1/programs/{program_id}/reward-sources/{reward_source_id}"
tags: ["Reward Sources"]
---

# Update reward source

`PATCH /v1/programs/{program_id}/reward-sources/{reward_source_id}`

## Request

- Base URL: `https://api.scrip.dev`
- URL: `https://api.scrip.dev/v1/programs/{program_id}/reward-sources/{reward_source_id}`
- Auth: HTTP bearer

Update a reward source's selection and pricing settings, or archive it by setting `status`.

## Path parameters

- `program_id` string, required
- `reward_source_id` string, required

## Request body

- UpdateRewardSourceRequest: Changes a reward source. Omitted fields stay the same, and an empty filter list clears that filter.
  - `category_filter` string[]: Category filter ([] clears the filter)
  - `country_filter` string[]: Country filter ([] clears the filter)
  - `default_rate` string: Asset units per currency minor unit of face value (decimal string)
  - `policy` string: Product selection: MANUAL or ALL
  - `status` 'ACTIVE' | 'ARCHIVED': Set to `ARCHIVED` to archive the reward source and its rewards, which cannot be undone; send `status` without other fields.

## Response `200`

Updated reward source

- RewardSourceResponse: A reward source: a program's link to a fulfillment account, with the rules for which products it offers.
  - `asset_id` string, uuid: Asset participants spend on these rewards
  - `category_filter` string[]: ALL-policy category filter (null = no filter)
  - `country_filter` string[]: ALL-policy country filter (null = no filter)
  - `created_at` string, date-time: When the reward source was created (RFC 3339)
  - `default_rate` string: Asset units per currency minor unit of face value (decimal string)
  - `fulfillment_account_id` string, uuid: Fulfillment account supplying these products
  - `id` string, uuid: The id of the reward source. Use it in `reward_source_id` fields and paths.
  - `policy` string: Product selection: MANUAL (nothing until products are enabled) or ALL
  - `program_id` string, uuid: Program this source belongs to
  - `status` 'ACTIVE' | 'ARCHIVED': The reward source's lifecycle state: ACTIVE or ARCHIVED.
  - `updated_at` string, date-time: When the reward source was last modified (RFC 3339)

## Other responses

- `400`: Validation failed (code: validation_error | invalid_rate | invalid_policy)
- `401`: The API key is missing or not valid. See [Authentication](https://docs.scrip.dev/authentication).
- `403`: The caller is not allowed to do this.
- `404`: Reward source not found (code: reward_source_not_found)
- `422`: Malformed country filter value (code: invalid_country)
- `429`: Too many requests. Wait the number of seconds in the `Retry-After` header, then retry. See [Limits and durations](https://docs.scrip.dev/limits#rate-limits).
- `500`: Something failed on Scrip's side. Retry the request, and quote `request_id` if it keeps failing. [Errors](https://docs.scrip.dev/errors) lists every code, and the [API introduction](https://docs.scrip.dev/api-reference/introduction) describes the error format.

---

[API](https://skmtc.dev/scrip/apis/scrip-api.md) · [All operations](https://skmtc.dev/scrip/apis/scrip-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrip/apis/scrip-api/revisions/c52d35da8d97?raw)