Update a rule

curl --request PATCH \
  --url https://api.scrip.dev/v1/rules/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "actions": [
    {
      "amount": "${{ event.amount * 0.03 }}",
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "description": "Purchase reward",
      "expires_at": "365d",
      "matures_at": "30d",
      "type": "CREDIT"
    }
  ],
  "active_from": "2024-01-01T00:00:00Z",
  "active_to": "2024-12-31T23:59:59Z",
  "budgets": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "limit": "10000.00"
    }
  ],
  "condition": "event.type == 'purchase'",
  "description": "Updated description",
  "name": "Updated Rule Name",
  "rule_set_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "SUSPENDED",
  "stop_after_match": true
}
EOF

import requests

url = "https://api.scrip.dev/v1/rules/{id}"

payload = {
    "actions": [
        {
            "amount": "${{ event.amount * 0.03 }}",
            "asset_id": "550e8400-e29b-41d4-a716-446655440000",
            "description": "Purchase reward",
            "expires_at": "365d",
            "matures_at": "30d",
            "type": "CREDIT"
        }
    ],
    "active_from": "2024-01-01T00:00:00Z",
    "active_to": "2024-12-31T23:59:59Z",
    "budgets": [
        {
            "asset_id": "550e8400-e29b-41d4-a716-446655440000",
            "limit": "10000.00"
        }
    ],
    "condition": "event.type == 'purchase'",
    "description": "Updated description",
    "name": "Updated Rule Name",
    "rule_set_id": "550e8400-e29b-41d4-a716-446655440001",
    "status": "SUSPENDED",
    "stop_after_match": True
}
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({
    actions: [
      {
        amount: '${{ event.amount * 0.03 }}',
        asset_id: '550e8400-e29b-41d4-a716-446655440000',
        description: 'Purchase reward',
        expires_at: '365d',
        matures_at: '30d',
        type: 'CREDIT'
      }
    ],
    active_from: '2024-01-01T00:00:00Z',
    active_to: '2024-12-31T23:59:59Z',
    budgets: [{asset_id: '550e8400-e29b-41d4-a716-446655440000', limit: '10000.00'}],
    condition: 'event.type == \'purchase\'',
    description: 'Updated description',
    name: 'Updated Rule Name',
    rule_set_id: '550e8400-e29b-41d4-a716-446655440001',
    status: 'SUSPENDED',
    stop_after_match: true
  })
};

fetch('https://api.scrip.dev/v1/rules/{id}', 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/rules/{id}",
  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([
    'actions' => [
        [
                'amount' => '${{ event.amount * 0.03 }}',
                'asset_id' => '550e8400-e29b-41d4-a716-446655440000',
                'description' => 'Purchase reward',
                'expires_at' => '365d',
                'matures_at' => '30d',
                'type' => 'CREDIT'
        ]
    ],
    'active_from' => '2024-01-01T00:00:00Z',
    'active_to' => '2024-12-31T23:59:59Z',
    'budgets' => [
        [
                'asset_id' => '550e8400-e29b-41d4-a716-446655440000',
                'limit' => '10000.00'
        ]
    ],
    'condition' => 'event.type == \'purchase\'',
    'description' => 'Updated description',
    'name' => 'Updated Rule Name',
    'rule_set_id' => '550e8400-e29b-41d4-a716-446655440001',
    'status' => 'SUSPENDED',
    'stop_after_match' => true
  ]),
  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/rules/{id}"

	payload := strings.NewReader("{\n  \"actions\": [\n    {\n      \"amount\": \"${{ event.amount * 0.03 }}\",\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"description\": \"Purchase reward\",\n      \"expires_at\": \"365d\",\n      \"matures_at\": \"30d\",\n      \"type\": \"CREDIT\"\n    }\n  ],\n  \"active_from\": \"2024-01-01T00:00:00Z\",\n  \"active_to\": \"2024-12-31T23:59:59Z\",\n  \"budgets\": [\n    {\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"limit\": \"10000.00\"\n    }\n  ],\n  \"condition\": \"event.type == 'purchase'\",\n  \"description\": \"Updated description\",\n  \"name\": \"Updated Rule Name\",\n  \"rule_set_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"status\": \"SUSPENDED\",\n  \"stop_after_match\": true\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/rules/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actions\": [\n    {\n      \"amount\": \"${{ event.amount * 0.03 }}\",\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"description\": \"Purchase reward\",\n      \"expires_at\": \"365d\",\n      \"matures_at\": \"30d\",\n      \"type\": \"CREDIT\"\n    }\n  ],\n  \"active_from\": \"2024-01-01T00:00:00Z\",\n  \"active_to\": \"2024-12-31T23:59:59Z\",\n  \"budgets\": [\n    {\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"limit\": \"10000.00\"\n    }\n  ],\n  \"condition\": \"event.type == 'purchase'\",\n  \"description\": \"Updated description\",\n  \"name\": \"Updated Rule Name\",\n  \"rule_set_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"status\": \"SUSPENDED\",\n  \"stop_after_match\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/rules/{id}")

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  \"actions\": [\n    {\n      \"amount\": \"${{ event.amount * 0.03 }}\",\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"description\": \"Purchase reward\",\n      \"expires_at\": \"365d\",\n      \"matures_at\": \"30d\",\n      \"type\": \"CREDIT\"\n    }\n  ],\n  \"active_from\": \"2024-01-01T00:00:00Z\",\n  \"active_to\": \"2024-12-31T23:59:59Z\",\n  \"budgets\": [\n    {\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"limit\": \"10000.00\"\n    }\n  ],\n  \"condition\": \"event.type == 'purchase'\",\n  \"description\": \"Updated description\",\n  \"name\": \"Updated Rule Name\",\n  \"rule_set_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"status\": \"SUSPENDED\",\n  \"stop_after_match\": true\n}"

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

{
  "actions": [
    {
      "amount": "${{ event.amount * 10 }}",
      "asset_id": "550e8400-e29b-41d4-a716-446655440002",
      "type": "CREDIT"
    }
  ],
  "active_from": "2024-01-01T00:00:00Z",
  "active_to": "2024-12-31T23:59:59Z",
  "budgets": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "consumed": "4500.00",
      "cron_expression": "0 0 1 * *",
      "interval": "720h",
      "limit": "10000.00",
      "next_reset_at": "2026-03-01T00:00:00Z",
      "schedule_type": "CRON"
    }
  ],
  "condition": "event.type == 'purchase' && event.amount > 0",
  "created_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2024-06-01T00:00:00Z",
  "description": "Awards 10 points per dollar spent",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Purchase Reward",
  "order": 1,
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "rule_configuration_version": 4,
  "rule_set_id": "550e8400-e29b-41d4-a716-446655440002",
  "status": "ACTIVE",
  "stop_after_match": false,
  "updated_at": "2024-01-15T10:30:00Z",
  "warnings": [
    {
      "code": "unknown_state_key",
      "key": "purchaseCnt",
      "kind": "counter",
      "message": "unknown counter \"purchaseCnt\" — no rule in this program writes it; did you mean \"purchase_count\"?",
      "scope": "participant",
      "suggestion": "purchase_count"
    }
  ]
}

{
  "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": "forbidden",
  "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": "Insufficient permissions for this action"
}

{
  "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": "unprocessable",
  "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": "Business rule violation"
}

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

PATCH

rules

{id}

Update a rule

curl --request PATCH \
  --url https://api.scrip.dev/v1/rules/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "actions": [
    {
      "amount": "${{ event.amount * 0.03 }}",
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "description": "Purchase reward",
      "expires_at": "365d",
      "matures_at": "30d",
      "type": "CREDIT"
    }
  ],
  "active_from": "2024-01-01T00:00:00Z",
  "active_to": "2024-12-31T23:59:59Z",
  "budgets": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "limit": "10000.00"
    }
  ],
  "condition": "event.type == 'purchase'",
  "description": "Updated description",
  "name": "Updated Rule Name",
  "rule_set_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "SUSPENDED",
  "stop_after_match": true
}
EOF

import requests

url = "https://api.scrip.dev/v1/rules/{id}"

payload = {
    "actions": [
        {
            "amount": "${{ event.amount * 0.03 }}",
            "asset_id": "550e8400-e29b-41d4-a716-446655440000",
            "description": "Purchase reward",
            "expires_at": "365d",
            "matures_at": "30d",
            "type": "CREDIT"
        }
    ],
    "active_from": "2024-01-01T00:00:00Z",
    "active_to": "2024-12-31T23:59:59Z",
    "budgets": [
        {
            "asset_id": "550e8400-e29b-41d4-a716-446655440000",
            "limit": "10000.00"
        }
    ],
    "condition": "event.type == 'purchase'",
    "description": "Updated description",
    "name": "Updated Rule Name",
    "rule_set_id": "550e8400-e29b-41d4-a716-446655440001",
    "status": "SUSPENDED",
    "stop_after_match": True
}
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({
    actions: [
      {
        amount: '${{ event.amount * 0.03 }}',
        asset_id: '550e8400-e29b-41d4-a716-446655440000',
        description: 'Purchase reward',
        expires_at: '365d',
        matures_at: '30d',
        type: 'CREDIT'
      }
    ],
    active_from: '2024-01-01T00:00:00Z',
    active_to: '2024-12-31T23:59:59Z',
    budgets: [{asset_id: '550e8400-e29b-41d4-a716-446655440000', limit: '10000.00'}],
    condition: 'event.type == \'purchase\'',
    description: 'Updated description',
    name: 'Updated Rule Name',
    rule_set_id: '550e8400-e29b-41d4-a716-446655440001',
    status: 'SUSPENDED',
    stop_after_match: true
  })
};

fetch('https://api.scrip.dev/v1/rules/{id}', 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/rules/{id}",
  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([
    'actions' => [
        [
                'amount' => '${{ event.amount * 0.03 }}',
                'asset_id' => '550e8400-e29b-41d4-a716-446655440000',
                'description' => 'Purchase reward',
                'expires_at' => '365d',
                'matures_at' => '30d',
                'type' => 'CREDIT'
        ]
    ],
    'active_from' => '2024-01-01T00:00:00Z',
    'active_to' => '2024-12-31T23:59:59Z',
    'budgets' => [
        [
                'asset_id' => '550e8400-e29b-41d4-a716-446655440000',
                'limit' => '10000.00'
        ]
    ],
    'condition' => 'event.type == \'purchase\'',
    'description' => 'Updated description',
    'name' => 'Updated Rule Name',
    'rule_set_id' => '550e8400-e29b-41d4-a716-446655440001',
    'status' => 'SUSPENDED',
    'stop_after_match' => true
  ]),
  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/rules/{id}"

	payload := strings.NewReader("{\n  \"actions\": [\n    {\n      \"amount\": \"${{ event.amount * 0.03 }}\",\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"description\": \"Purchase reward\",\n      \"expires_at\": \"365d\",\n      \"matures_at\": \"30d\",\n      \"type\": \"CREDIT\"\n    }\n  ],\n  \"active_from\": \"2024-01-01T00:00:00Z\",\n  \"active_to\": \"2024-12-31T23:59:59Z\",\n  \"budgets\": [\n    {\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"limit\": \"10000.00\"\n    }\n  ],\n  \"condition\": \"event.type == 'purchase'\",\n  \"description\": \"Updated description\",\n  \"name\": \"Updated Rule Name\",\n  \"rule_set_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"status\": \"SUSPENDED\",\n  \"stop_after_match\": true\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/rules/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actions\": [\n    {\n      \"amount\": \"${{ event.amount * 0.03 }}\",\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"description\": \"Purchase reward\",\n      \"expires_at\": \"365d\",\n      \"matures_at\": \"30d\",\n      \"type\": \"CREDIT\"\n    }\n  ],\n  \"active_from\": \"2024-01-01T00:00:00Z\",\n  \"active_to\": \"2024-12-31T23:59:59Z\",\n  \"budgets\": [\n    {\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"limit\": \"10000.00\"\n    }\n  ],\n  \"condition\": \"event.type == 'purchase'\",\n  \"description\": \"Updated description\",\n  \"name\": \"Updated Rule Name\",\n  \"rule_set_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"status\": \"SUSPENDED\",\n  \"stop_after_match\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/rules/{id}")

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  \"actions\": [\n    {\n      \"amount\": \"${{ event.amount * 0.03 }}\",\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"description\": \"Purchase reward\",\n      \"expires_at\": \"365d\",\n      \"matures_at\": \"30d\",\n      \"type\": \"CREDIT\"\n    }\n  ],\n  \"active_from\": \"2024-01-01T00:00:00Z\",\n  \"active_to\": \"2024-12-31T23:59:59Z\",\n  \"budgets\": [\n    {\n      \"asset_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"limit\": \"10000.00\"\n    }\n  ],\n  \"condition\": \"event.type == 'purchase'\",\n  \"description\": \"Updated description\",\n  \"name\": \"Updated Rule Name\",\n  \"rule_set_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"status\": \"SUSPENDED\",\n  \"stop_after_match\": true\n}"

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

{
  "actions": [
    {
      "amount": "${{ event.amount * 10 }}",
      "asset_id": "550e8400-e29b-41d4-a716-446655440002",
      "type": "CREDIT"
    }
  ],
  "active_from": "2024-01-01T00:00:00Z",
  "active_to": "2024-12-31T23:59:59Z",
  "budgets": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "consumed": "4500.00",
      "cron_expression": "0 0 1 * *",
      "interval": "720h",
      "limit": "10000.00",
      "next_reset_at": "2026-03-01T00:00:00Z",
      "schedule_type": "CRON"
    }
  ],
  "condition": "event.type == 'purchase' && event.amount > 0",
  "created_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2024-06-01T00:00:00Z",
  "description": "Awards 10 points per dollar spent",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Purchase Reward",
  "order": 1,
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "rule_configuration_version": 4,
  "rule_set_id": "550e8400-e29b-41d4-a716-446655440002",
  "status": "ACTIVE",
  "stop_after_match": false,
  "updated_at": "2024-01-15T10:30:00Z",
  "warnings": [
    {
      "code": "unknown_state_key",
      "key": "purchaseCnt",
      "kind": "counter",
      "message": "unknown counter \"purchaseCnt\" — no rule in this program writes it; did you mean \"purchase_count\"?",
      "scope": "participant",
      "suggestion": "purchase_count"
    }
  ]
}

{
  "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": "forbidden",
  "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": "Insufficient permissions for this action"
}

{
  "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": "unprocessable",
  "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": "Business rule violation"
}

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

Partially updates a rule’s configuration. You can modify name, description, condition, actions, rule_set_id, stop_after_match, active_from, active_to, budgets, or status. Only the fields included in the request body are changed; omitted fields remain untouched. The budgets field is a full replacement when present. The provided array replaces all existing budgets. Omitting the field leaves budgets unchanged. To remove all budgets, send an empty budgets array. To suspend a rule without archiving it, set status to SUSPENDED. To archive a rule, set status to ARCHIVED. Suspended rules retain their position. Archived rules leave the sequence. stop_after_match remains local to the rule’s containing set. Moving a stopping rule changes which later rules it can skip. Supplying rule_set_id moves the rule to that set and renumbers both affected sets. To also control where it lands, use the move rule endpoint, which takes a position and an expected_rule_configuration_version for conflict-safe placement. Archived rules cannot be modified. Rules belonging to an archived program also cannot be modified. Successful configuration changes include the resulting rule_configuration_version; no-op writes retain the current version.

For moving and conflict-safe reordering patterns, see the Rule sets guide.

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string<uuid>

required

Rule ID

Body

application/json

Fields to update

Request body for updating an existing rule. Only provided fields are updated; at least one field must be specified.

actions

CREDIT action · object · DEBIT action · object · HOLD action · object · RELEASE action · object · RELEASE action · object · FORFEIT action · object · VOID_HOLD action · object · TAG action · object · UNTAG action · object · COUNTER action · object · SET_ATTRIBUTE action · object · SET_TIER action · object · SCHEDULE_EVENT action · object · BROADCAST action · object[]

Replacement actions array. Omit to leave actions unchanged. If provided, must be non-empty.

Credit an asset to the target. Requires asset_id and a positive amount. reference_id, expires_at, and matures_at apply to LOT-mode assets only.

Show child attributes

Example:

{
  "amount": "${{ event.amount * 0.03 }}",
  "asset_id": "550e8400-e29b-41d4-a716-446655440000",
  "description": "Purchase reward",
  "expires_at": "365d",
  "matures_at": "30d",
  "type": "CREDIT"
}

active_from

string<date-time>

Start of the rule's active window (RFC 3339). Send null to clear.

Example:

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

active_to

string<date-time>

End of the rule's active window (RFC 3339). Send null to clear.

Example:

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

budgets

(Lifetime budget · object | Cron budget · object | Interval budget · object)[]

Replacement budget array. Omit to leave budgets unchanged. Send empty array to remove all budgets.

Never resets. schedule_type, cron_expression, and interval are all rejected.

Lifetime budget
Cron budget
Interval budget

Show child attributes

condition

string

Updated CEL expression

Minimum string length: 1

Example:

"event.type == 'purchase'"

description

string

Updated description

Maximum string length: 1000

Example:

"Updated description"

name

string

Updated display name

Required string length: 1 - 255

Example:

"Updated Rule Name"

rule_set_id

string<uuid>

Move this rule to another rule set. Omit to keep the current assignment.

Example:

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

status

enum<string>

Updated lifecycle status: ACTIVE, SUSPENDED, or ARCHIVED

Available options:

ACTIVE,

SUSPENDED,

ARCHIVED

Example:

"SUSPENDED"

stop_after_match

boolean

Whether to stop evaluating subsequent rules in this set after this one matches; other sets continue

Example:

true

Response

Updated rule

actions

object[]

Actions to execute when the condition matches

Example:

[
  {
    "amount": "${{ event.amount * 10 }}",
    "asset_id": "550e8400-e29b-41d4-a716-446655440002",
    "type": "CREDIT"
  }
]

active_from

string<date-time>

Start of the rule's active window (RFC 3339, null if always active). Checked against the event's event_timestamp, inclusive.

Example:

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

active_to

string<date-time>

End of the rule's active window (RFC 3339, null if no end date). Checked against the event's event_timestamp, exclusive.

Example:

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

budgets

object[]

Budget constraints applied to this rule

Show child attributes

condition

string

CEL expression that determines when the rule fires

Example:

"event.type == 'purchase' && event.amount > 0"

created_at

string<date-time>

When this rule was created (RFC 3339)

Example:

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

deleted_at

string<date-time>

When this rule was archived (null if not archived)

Example:

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

description

string

Human-readable summary of what this rule does

Example:

"Awards 10 points per dollar spent"

string<uuid>

Unique identifier for this rule

Example:

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

name

string

Display name

Example:

"Purchase Reward"

order

integer

Evaluation position within the containing rule set (lower = first; ACTIVE and SUSPENDED rules occupy unique positions)

Example:

1

program_id

string<uuid>

Program this rule belongs to

Example:

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

rule_configuration_version

integer

Resulting program rule-configuration revision. Present on mutation responses.

Example:

4

rule_set_id

string<uuid>

Rule set that contains this rule and scopes its order and stop_after_match behavior

Example:

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

status

string

Lifecycle status: ACTIVE, SUSPENDED, or ARCHIVED

Example:

"ACTIVE"

stop_after_match

boolean

When true, no subsequent rules in this set evaluate after this one matches; other sets continue

Example:

false

updated_at

string<date-time>

When this rule was last modified (RFC 3339)

Example:

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

warnings

object[]

Non-blocking advisories about the rule's condition or action expressions, such as unknown state-key typos or deprecated CEL aliases. Present on create/update only; never blocks the save.

Show child attributes

Scrip API

Endpoints

Update a rule

Authorizations

Path Parameters

Body

Response