Replace forms

Replaces a form whole and answers it as stored.

PUT /v1/form/forms/{id}

Form → · All API references → · Get started →

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

Replaces a form whole and answers it as stored. Named by a slug no form has yet, it makes the form under that slug, so a definition written twice is one form: the way a seed states a form. A field sent with its id keeps it; a type the platform no longer offers stays answerable where the form already asks it, and is refused where it is new. An org admin only.

Request

62 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the form's id: 15 lowercase hex characters, derived from the slug when the form has one, so a slug names one form for good.
`created`	body	string	—	Created is when the form was made, RFC 3339.
`fields`	body	form.Field[]	—	Fields are the questions, in the order they are asked.
`fields[].choices`	body	form.Choice[]	—	Choices are what a multiple_choice or dropdown field offers, in order.
`fields[].choices[].id`	body	string	—	ID is the choice's id, assigned when empty.
`fields[].choices[].label`	body	string	—	Label is the choice as shown.
`fields[].choices[].ref`	body	string	—	Ref is how an answer names the choice; unique in the field, defaults to the id.
`fields[].description`	body	string	—	Description is the line under the question.
`fields[].id`	body	string	—	ID is the field's id: assigned when a write leaves it empty, and kept across edits by sending it back.
`fields[].labels`	body	form.Labels	—
`fields[].labels.center`	body	string	—
`fields[].labels.left`	body	string	—
`fields[].labels.right`	body	string	—
`fields[].multiple`	body	boolean	—	Multiple is whether a multiple_choice field takes several choices.
`fields[].ref`	body	string	—	Ref is the field's stable name, how an answer and a sink name it: lowercase letters, digits, dash and underscore, at most 64, unique in the form.
`fields[].required`	body	boolean	—	Required is whether a completed response must answer it.
`fields[].start`	body	integer (int64)	—	Start is where an opinion_scale begins: 0 (the default) or 1.
`fields[].steps`	body	integer (int64)	—	Steps is how many points a rating (3 to 10, default 5) or an opinion_scale (5 to 11, default 11) has.
`fields[].title`	body	string	—	Title is the question as asked.
`fields[].type`	body	string	—	Type is one of short_text, long_text, email, phone, url, number, rating, opinion_scale, yes_no, multiple_choice, dropdown, date and statement.
`fields[].validations`	body	form.Validations	—
`fields[].validations.max_length`	body	integer (int64)	—	MaxLength is the most characters a text answer holds, at most the platform's bound for the type.
`fields[].validations.max_value`	body	number (double)	—	MaxValue is the most a number answer may be.
`fields[].validations.min_value`	body	number (double)	—	MinValue is the least a number answer may be.
`hidden`	body	string[]	—	Hidden names the values a page passes in when it embeds the form (a video id, a plan): lowercase letters, digits and underscores, at most 32 each.
`id`	body	string	—	ID is the form's id: 15 lowercase hex characters, derived from the slug when the form has one, so a slug names one form for good.
`kind`	body	string	—	Kind is form (every submission is a response, the default) or subscribe (a mailing list: an email field is required and one address is one response).
`public_id`	body	string	—	PublicID is the address the form is answered at: "<org>.<slug or id>", as GET /v1/form/public/{id} and POST /v1/form/public/{id}/responses take it.
`settings`	body	form.Options	—
`settings.identity`	body	string	—	Identity is who a response is from when nobody is signed in.
`settings.language`	body	string	—	Language is the form's language, a tag like en or pt-BR.
`settings.mode`	body	string	—	Mode is one (a question at a time, the default) or all (every question at once).
`settings.progress`	body	boolean	—	Progress is whether the renderer shows a progress bar.
`settings.visibility`	body	string	—	Visibility is public (answerable at its public address by anyone) or private (not served there).
`sinks`	body	form.Sinks	—
`sinks.crm`	body	form.CRM	—
`sinks.crm.company`	body	string	—	Company is the ref of the field whose answer is the person's company.
`sinks.crm.email`	body	string	—	Email is the ref of the field whose answer is the person's address.
`sinks.crm.list`	body	string	—	List is the CRM list the person joins, by name (a subscribe form's mailing list).
`sinks.crm.name`	body	string	—	Name is the ref of the field whose answer is the person's name.
`sinks.events`	body	boolean	—	Events states form_viewed, form_started and form_submitted on the deployment's event stream: the form's ids and the refs of the fields answered, never an answer's text.
`sinks.forward`	body	form.Forward	—
`sinks.forward.email`	body	string	—	Email is the address.
`sinks.forward.name`	body	string	—	Name is who it is, for the greeting.
`sinks.welcome`	body	form.Welcome	—
`sinks.welcome.body`	body	string	—	Body is the mail's text: plain text, a blank line a new paragraph.
`sinks.welcome.subject`	body	string	—	Subject is the mail's subject.
`slug`	body	string	—	Slug is the form's own name within its org: lowercase letters, digits and dashes, at most 64.
`tags`	body	string[]	—	Tags label the form for its org: at most 20, each at most 64 characters.
`thanks`	body	form.Screen	—
`thanks.button`	body	string	—	Button is the button's label.
`thanks.description`	body	string	—	Description is the text under it.
`thanks.redirect`	body	string	—	Redirect is where a thank-you screen sends the respondent instead of showing itself: an https address.
`thanks.title`	body	string	—	Title is the screen's heading.
`theme`	body	string	—	Theme is the id of the theme the form is drawn in.
`title`	body	string	—	Title is the form's name, as a respondent and the CRM timeline read it.
`updated`	body	string	—	Updated is when it last changed, RFC 3339.
`welcome`	body	form.Screen	—
`welcome.button`	body	string	—	Button is the button's label.
`welcome.description`	body	string	—	Description is the text under it.
`welcome.redirect`	body	string	—	Redirect is where a thank-you screen sends the respondent instead of showing itself: an https address.
`welcome.title`	body	string	—	Title is the screen's heading.

Response

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

200 body — 61 fields.

Field	In	Type	Always	Description
`created`	body	string	—	Created is when the form was made, RFC 3339.
`fields`	body	form.Field[]	—	Fields are the questions, in the order they are asked.
`fields[].choices`	body	form.Choice[]	—	Choices are what a multiple_choice or dropdown field offers, in order.
`fields[].choices[].id`	body	string	—	ID is the choice's id, assigned when empty.
`fields[].choices[].label`	body	string	—	Label is the choice as shown.
`fields[].choices[].ref`	body	string	—	Ref is how an answer names the choice; unique in the field, defaults to the id.
`fields[].description`	body	string	—	Description is the line under the question.
`fields[].id`	body	string	—	ID is the field's id: assigned when a write leaves it empty, and kept across edits by sending it back.
`fields[].labels`	body	form.Labels	—
`fields[].labels.center`	body	string	—
`fields[].labels.left`	body	string	—
`fields[].labels.right`	body	string	—
`fields[].multiple`	body	boolean	—	Multiple is whether a multiple_choice field takes several choices.
`fields[].ref`	body	string	—	Ref is the field's stable name, how an answer and a sink name it: lowercase letters, digits, dash and underscore, at most 64, unique in the form.
`fields[].required`	body	boolean	—	Required is whether a completed response must answer it.
`fields[].start`	body	integer (int64)	—	Start is where an opinion_scale begins: 0 (the default) or 1.
`fields[].steps`	body	integer (int64)	—	Steps is how many points a rating (3 to 10, default 5) or an opinion_scale (5 to 11, default 11) has.
`fields[].title`	body	string	—	Title is the question as asked.
`fields[].type`	body	string	—	Type is one of short_text, long_text, email, phone, url, number, rating, opinion_scale, yes_no, multiple_choice, dropdown, date and statement.
`fields[].validations`	body	form.Validations	—
`fields[].validations.max_length`	body	integer (int64)	—	MaxLength is the most characters a text answer holds, at most the platform's bound for the type.
`fields[].validations.max_value`	body	number (double)	—	MaxValue is the most a number answer may be.
`fields[].validations.min_value`	body	number (double)	—	MinValue is the least a number answer may be.
`hidden`	body	string[]	—	Hidden names the values a page passes in when it embeds the form (a video id, a plan): lowercase letters, digits and underscores, at most 32 each.
`id`	body	string	—	ID is the form's id: 15 lowercase hex characters, derived from the slug when the form has one, so a slug names one form for good.
`kind`	body	string	—	Kind is form (every submission is a response, the default) or subscribe (a mailing list: an email field is required and one address is one response).
`public_id`	body	string	—	PublicID is the address the form is answered at: "<org>.<slug or id>", as GET /v1/form/public/{id} and POST /v1/form/public/{id}/responses take it.
`settings`	body	form.Options	—
`settings.identity`	body	string	—	Identity is who a response is from when nobody is signed in.
`settings.language`	body	string	—	Language is the form's language, a tag like en or pt-BR.
`settings.mode`	body	string	—	Mode is one (a question at a time, the default) or all (every question at once).
`settings.progress`	body	boolean	—	Progress is whether the renderer shows a progress bar.
`settings.visibility`	body	string	—	Visibility is public (answerable at its public address by anyone) or private (not served there).
`sinks`	body	form.Sinks	—
`sinks.crm`	body	form.CRM	—
`sinks.crm.company`	body	string	—	Company is the ref of the field whose answer is the person's company.
`sinks.crm.email`	body	string	—	Email is the ref of the field whose answer is the person's address.
`sinks.crm.list`	body	string	—	List is the CRM list the person joins, by name (a subscribe form's mailing list).
`sinks.crm.name`	body	string	—	Name is the ref of the field whose answer is the person's name.
`sinks.events`	body	boolean	—	Events states form_viewed, form_started and form_submitted on the deployment's event stream: the form's ids and the refs of the fields answered, never an answer's text.
`sinks.forward`	body	form.Forward	—
`sinks.forward.email`	body	string	—	Email is the address.
`sinks.forward.name`	body	string	—	Name is who it is, for the greeting.
`sinks.welcome`	body	form.Welcome	—
`sinks.welcome.body`	body	string	—	Body is the mail's text: plain text, a blank line a new paragraph.
`sinks.welcome.subject`	body	string	—	Subject is the mail's subject.
`slug`	body	string	—	Slug is the form's own name within its org: lowercase letters, digits and dashes, at most 64.
`tags`	body	string[]	—	Tags label the form for its org: at most 20, each at most 64 characters.
`thanks`	body	form.Screen	—
`thanks.button`	body	string	—	Button is the button's label.
`thanks.description`	body	string	—	Description is the text under it.
`thanks.redirect`	body	string	—	Redirect is where a thank-you screen sends the respondent instead of showing itself: an https address.
`thanks.title`	body	string	—	Title is the screen's heading.
`theme`	body	string	—	Theme is the id of the theme the form is drawn in.
`title`	body	string	—	Title is the form's name, as a respondent and the CRM timeline read it.
`updated`	body	string	—	Updated is when it last changed, RFC 3339.
`welcome`	body	form.Screen	—
`welcome.button`	body	string	—	Button is the button's label.
`welcome.description`	body	string	—	Description is the text under it.
`welcome.redirect`	body	string	—	Redirect is where a thank-you screen sends the respondent instead of showing itself: an https address.
`welcome.title`	body	string	—	Title is the screen's heading.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo form forms 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.replaceForm({ id: 'id', created: "<created>", fields: [{"choices":[{"id":null,"label":null,"ref":null}],"description":"<description>","id":"<id>","labels":{"center":"<center>","left":"<left>","right":"<right>"}}] });

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(id='id', created="<created>", fields=[{"choices":[{"id":null,"label":null,"ref":null}],"description":"<description>","id":"<id>","labels":{"center":"<center>","left":"<left>","right":"<right>"}}])

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

resp, _, err := client.FormAPI.ReplaceForm(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(&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).replaceForm();

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/forms/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "created": "<created>",
       "fields": [
         {
           "choices": [
             {
               "id": null,
               "label": null,
               "ref": null
             }
           ],
           "description": "<description>",
           "id": "<id>",
           "labels": {
             "center": "<center>",
             "left": "<left>",
             "right": "<right>"
           }
         }
       ]
     }'

Tool form, op replace_form — 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",
           "input": {
             "id": "<id>",
             "created": "<created>",
             "fields": [
               {
                 "choices": [
                   {
                     "id": null,
                     "label": null,
                     "ref": null
                   }
                 ],
                 "description": "<description>",
                 "id": "<id>",
                 "labels": {
                   "center": "<center>",
                   "left": "<left>",
                   "right": "<right>"
                 }
               }
             ]
           }
         }
       }
     }'

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.

PreviousReplace webhooks NextCreate responses