Skip to main content
PATCH
/
v1
/
settlement-templates
/
{template_id}
Update template
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    config: {
      states: ['<string>'],
      initial_state: '<string>',
      terminal_states: ['<string>'],
      failure_states: ['<string>'],
      transitions: {},
      asset_providers: {},
      payment_providers: {},
      compliance: {recheck_at_states: [], entity_providers: [], wallet_providers: []},
      required_roles: ['seller', 'buyer'],
      actions: {}
    },
    is_active: true
  })
};

fetch('https://api.keystoneos.xyz/v1/settlement-templates/{template_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "config": {
    "states": [
      "<string>"
    ],
    "initial_state": "<string>",
    "terminal_states": [
      "<string>"
    ],
    "failure_states": [
      "<string>"
    ],
    "transitions": {},
    "asset_providers": {},
    "payment_providers": {},
    "compliance": {
      "recheck_at_states": [],
      "entity_providers": [],
      "wallet_providers": []
    },
    "required_roles": [
      "seller",
      "buyer"
    ],
    "actions": {}
  },
  "version": 123,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

template_id
string<uuid>
required

Body

application/json
name
string | null
description
string | null
config
TemplateConfig · object
is_active
boolean | null

Response

Successful Response

id
string<uuid>
required
platform_id
string<uuid>
required
name
string
required
description
string | null
required
config
TemplateConfig · object
required
version
integer
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required