Update Ui Resource Template

Update an existing UI resource template.

PUT /api/v1/ui-resource-templates/{template_id}

Update Ui Resource Template

cURL

curl --request PUT \
  --url https://{tenant_id}.api.useago.com/api/v1/ui-resource-templates/{template_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "template_content": "<string>",
  "context_schema": {},
  "preview_context_data": {},
  "is_active": true
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/ui-resource-templates/{template_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "template_content": "<string>",
    "context_schema": {},
    "preview_context_data": {},
    "is_active": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    template_content: '<string>',
    context_schema: {},
    preview_context_data: {},
    is_active: true
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/ui-resource-templates/{template_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "name": "<string>",
  "template_content": "<string>",
  "object": "ui_resource_template",
  "description": "",
  "context_schema": {},
  "preview_context_data": {},
  "is_active": true,
  "template_version": 1,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

template_id · string · required

Body

application/json

Schema for updating a UI resource template via the v1 API.

name · string | null

description · string | null

template_content · string | null

context_schema · Context Schema · object | null

preview_context_data · Preview Context Data · object | null

is_active · boolean | null

Response

200 - application/json

OK

Response schema for UI resource templates.

id · string · required

name · string · required

template_content · string · required

object · string · default: ui_resource_template

description · string · default: ""

context_schema · Context Schema · object

preview_context_data · Preview Context Data · object

is_active · boolean · default: true

template_version · integer · default: 1

created_at · string | null

updated_at · string | null