Replace themes

Replaces a theme whole; every form drawn in it is drawn in the new one.

PUT /v1/form/themes/{id}

Form → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/form/themes/{id}`
Method	`PUT`
Operation	`replace_form_theme`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Replaces a theme whole; every form drawn in it is drawn in the new one. An org admin only.

Request

12 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the theme's id.
`background`	body	string	—	Background is an https address of an image drawn behind the form.
`colors`	body	form.Colors	—
`colors.answer`	body	string	—
`colors.background`	body	string	—
`colors.button`	body	string	—
`colors.question`	body	string	—
`created`	body	string	—	Created is when the theme was made, RFC 3339.
`font`	body	string	—	Font is the font family the form is set in: letters, digits, spaces and dashes, at most 64.
`id`	body	string	—	ID is the theme's id.
`name`	body	string	—	Name is the theme's name in its org.
`updated`	body	string	—	Updated is when it last changed, RFC 3339.

Response

Status	Body	Meaning
`200`	form.Theme	ok
`default`	problem-details	refused

200 body — 11 fields.

Field	In	Type	Always	Description
`background`	body	string	—	Background is an https address of an image drawn behind the form.
`colors`	body	form.Colors	—
`colors.answer`	body	string	—
`colors.background`	body	string	—
`colors.button`	body	string	—
`colors.question`	body	string	—
`created`	body	string	—	Created is when the theme was made, RFC 3339.
`font`	body	string	—	Font is the font family the form is set in: letters, digits, spaces and dashes, at most 64.
`id`	body	string	—	ID is the theme's id.
`name`	body	string	—	Name is the theme's name in its org.
`updated`	body	string	—	Updated is when it last changed, RFC 3339.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo form themes set <id>

.ts

.py

.go

.rs

.java

import { Configuration, FormApi } from 'hanzoai';

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.replaceFormTheme({ id: 'id', background: "<background>", colors: {"answer":"<answer>","background":"<background>","button":"<button>","question":"<question>"} });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FormApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FormApi(client).replace_form_theme(id='id', background="<background>", colors={"answer":"<answer>","background":"<background>","button":"<button>","question":"<question>"})

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FormAPI.ReplaceFormTheme(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, form_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = form_api::replace_form_theme(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FormApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FormApi(client).replaceFormTheme();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X PUT https://api.hanzo.ai/v1/form/themes/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "background": "<background>",
       "colors": {
         "answer": "<answer>",
         "background": "<background>",
         "button": "<button>",
         "question": "<question>"
       }
     }'

Tool form, op replace_form_theme — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "form",
         "arguments": {
           "op": "replace_form_theme",
           "input": {
             "id": "<id>",
             "background": "<background>",
             "colors": {
               "answer": "<answer>",
               "background": "<background>",
               "button": "<button>",
               "question": "<question>"
             }
           }
         }
       }
     }'

Form API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousRetry deliveries NextReplace webhooks