Skip to main content
PATCH
/
api
/
v3
/
admin
/
promotions
/
{promotion_id}
/
promotion_rules
/
{id}
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const rule = await client.promotions.rules.update('promo_UkLWZg9DAJ', 'promorule_k5nR8xLq', {
  preferences: { currency: 'USD' },
})
{
  "id": "prorule_UkLWZg9DAJ",
  "created_at": "2026-06-17T13:37:49.065Z",
  "updated_at": "2026-06-17T13:37:49.342Z",
  "type": "currency",
  "promotion_id": "promo_UkLWZg9DAJ",
  "preferences": {
    "currency": "GBP"
  },
  "preference_schema": [
    {
      "key": "currency",
      "type": "string",
      "default": null
    }
  ],
  "label": "Currency",
  "product_ids": null,
  "category_ids": null,
  "customer_ids": null
}

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

promotion_id
string
required
id
string
required

Body

application/json
preferences
object

Response

200 - application/json

rule updated