Update an asset

PATCH /assets/{assetId}

Path parameters

assetId string Required

Body

asset_code string Required

Maximum length is 12.
offer_starting_at string(date) Required
offer_period number Required

Number of days
amount number Required

Max amount raised
currency string Required

Asset currency
tokenisation_strategy string Required

Value is claimable.
metadata object Required
Hide metadata attributes Show metadata attributes object
- coupon_bps number
- coupon_frequency string
  
  Values are monthly, quarterly, bi-annual, annual, or zero-coupon.
- coupon_currency string
- asset_id string
  
  eg ISIN
- denomination number
  
  Denomination per unit in currency
- callable boolean
- issuer_name string
  
  Name or identifier of a partner bank
- issuance_country string
- asset_type string
  
  Values are corporate, municipal, or government.
- maturity string(date)
- seniority string
  
  Values are junior or senior.
- description string
- issued_on string(date)

Responses

200

OK
Hide response attributes Show response attributes object
- id string(uuid)
- asset_code string
  
  Maximum length is 12.
- asset_issuer string
- offer_starting_at string(date)
- offer_period number
  
  Number of days
- amount number
  
  Max amount raised
- allocated_amount number
- currency string
  
  Asset currency
- allocated_at string(date)
- tokenised_at string(date)
- tokenisation_strategy string
  
  Value is claimable.
- metadata object
  
  Hide metadata attributes Show metadata attributes object
  
  coupon_bps number
  
  coupon_frequency string
  
  Values are monthly, quarterly, bi-annual, annual, or zero-coupon.
  
  coupon_currency string
  
  asset_id string
  
  eg ISIN
  
  denomination number
  
  Denomination per unit in currency
  
  callable boolean
  
  issuer_name string
  
  Name or identifier of a partner bank
  
  issuance_country string
  
  asset_type string
  
  Values are corporate, municipal, or government.
  
  maturity string(date)
  
  seniority string
  
  Values are junior or senior.
  
  description string
  
  issued_on string(date)
401

Unauthorized

PATCH /assets/{assetId}

curl \
 -X PATCH https://assets.demo.bitbond.net/api/v1/assets/{assetId} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"asset_code":"string","offer_starting_at":"2023-05-04","offer_period":42.0,"amount":42.0,"currency":"string","tokenisation_strategy":"claimable","metadata":{"coupon_bps":42.0,"coupon_frequency":"monthly","coupon_currency":"string","asset_id":"string","denomination":42.0,"callable":true,"issuer_name":"string","issuance_country":"string","asset_type":"corporate","maturity":"2023-05-04","seniority":"junior","description":"string","issued_on":"2023-05-04"}}'

Request example

{
  "asset_code": "string",
  "offer_starting_at": "2023-05-04",
  "offer_period": 42.0,
  "amount": 42.0,
  "currency": "string",
  "tokenisation_strategy": "claimable",
  "metadata": {
    "coupon_bps": 42.0,
    "coupon_frequency": "monthly",
    "coupon_currency": "string",
    "asset_id": "string",
    "denomination": 42.0,
    "callable": true,
    "issuer_name": "string",
    "issuance_country": "string",
    "asset_type": "corporate",
    "maturity": "2023-05-04",
    "seniority": "junior",
    "description": "string",
    "issued_on": "2023-05-04"
  }
}

Request examples

{
  "asset_code": "string",
  "offer_starting_at": "2025-05-04",
  "offer_period": 42.0,
  "amount": 42.0,
  "currency": "string",
  "tokenisation_strategy": "claimable",
  "metadata": {
    "coupon_bps": 42.0,
    "coupon_frequency": "monthly",
    "coupon_currency": "string",
    "asset_id": "string",
    "denomination": 42.0,
    "callable": true,
    "issuer_name": "string",
    "issuance_country": "string",
    "asset_type": "corporate",
    "maturity": "2025-05-04",
    "seniority": "junior",
    "description": "string",
    "issued_on": "2025-05-04"
  }
}

Response examples (200)

{
  "id": "string",
  "asset_code": "string",
  "asset_issuer": "string",
  "offer_starting_at": "2023-05-04",
  "offer_period": 42.0,
  "amount": 42.0,
  "allocated_amount": 42.0,
  "currency": "string",
  "allocated_at": "2023-05-04",
  "tokenised_at": "2023-05-04",
  "tokenisation_strategy": "claimable",
  "metadata": {
    "coupon_bps": 42.0,
    "coupon_frequency": "monthly",
    "coupon_currency": "string",
    "asset_id": "string",
    "denomination": 42.0,
    "callable": true,
    "issuer_name": "string",
    "issuance_country": "string",
    "asset_type": "corporate",
    "maturity": "2023-05-04",
    "seniority": "junior",
    "description": "string",
    "issued_on": "2023-05-04"
  }
}

Response examples (200)

{
  "id": "string",
  "asset_code": "string",
  "asset_issuer": "string",
  "offer_starting_at": "2025-05-04",
  "offer_period": 42.0,
  "amount": 42.0,
  "allocated_amount": 42.0,
  "currency": "string",
  "allocated_at": "2025-05-04",
  "tokenised_at": "2025-05-04",
  "tokenisation_strategy": "claimable",
  "metadata": {
    "coupon_bps": 42.0,
    "coupon_frequency": "monthly",
    "coupon_currency": "string",
    "asset_id": "string",
    "denomination": 42.0,
    "callable": true,
    "issuer_name": "string",
    "issuance_country": "string",
    "asset_type": "corporate",
    "maturity": "2025-05-04",
    "seniority": "junior",
    "description": "string",
    "issued_on": "2025-05-04"
  }
}