Skip to main content
PATCH
/
v1
/
assets
/
{id}
Update an asset
curl --request PATCH \
  --url https://api.scrip.dev/v1/assets/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "max_transaction_amount": "10000.00",
  "name": "Updated Asset Name",
  "status": "ARCHIVED"
}
'
{
  "created_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inventory_mode": "SIMPLE",
  "issuance_policy": "UNLIMITED",
  "max_transaction_amount": "10000.00",
  "name": "Bonus Points",
  "program_ids": [
    "550e8400-e29b-41d4-a716-446655440001"
  ],
  "scale": 2,
  "status": "ACTIVE",
  "symbol": "PTS",
  "updated_at": "2024-01-15T10:30:00Z"
}
Updates an asset’s name. Only include the fields you want to change; omitted fields are left unchanged. Set status to ARCHIVED to permanently retire an asset. Archived assets stop accepting new ledger entries but preserve all historical data. This cannot be reversed. The inventory_mode, issuance_policy, and scale fields cannot be modified because they govern ledger behavior. If you need different settings, create a new asset.
For usage patterns and examples, see the Asset Configuration guide.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Asset ID

Body

application/json

Fields to update

​
max_transaction_amount
string

Optional per-transaction ceiling. Positive decimal string to set, null to clear. Omit to leave unchanged

Example:

"10000.00"

​
name
string

Asset name

Required string length: 1 - 255
Example:

"Updated Asset Name"

​
status
enum<string>

Set to ARCHIVED to permanently retire this asset. Cannot be reversed

Available options:
ARCHIVED
Example:

"ARCHIVED"

Response

Updated asset

​
created_at
string<date-time>

When the asset was created

Example:

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

​
deleted_at
string<date-time>

Set when the asset is archived

​
id
string<uuid>

Asset ID

Example:

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

​
inventory_mode
string

How balances are tracked

Example:

"SIMPLE"

​
issuance_policy
string

How value is issued

Example:

"UNLIMITED"

​
max_transaction_amount
string

Optional per-transaction ceiling. Null means no limit

Example:

"10000.00"

​
name
string

Asset name

Example:

"Bonus Points"

​
program_ids
string[]

Programs this asset is linked to

Example:
["550e8400-e29b-41d4-a716-446655440001"]
​
scale
integer

Decimal precision

Example:

2

​
status
string

Lifecycle state

Example:

"ACTIVE"

​
symbol
string

Short code for this asset

Example:

"PTS"

​
updated_at
string<date-time>

When the asset was last modified

Example:

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