Create responses

POST /v1/form/public/{id}/responses

Answers a published form. No credential is needed.

The answers are read against the form's own fields: each names a field (by ref) once and carries the one value its type takes, inside its bounds; a completed submission answers every required field. Hidden values are the names the form declares. The response is from the signed-in person when there is one (their account, from their token, never from the body), else from the email field's answer, else from the page's visitor id.

Idempotent by token: the same token is the same response, so a submission sent twice files one. With completed false the answers so far are saved and the response stays open; a completed response is final and a later submission under its token is answered with it unchanged. A subscribe form's response is keyed by its address instead: one address is one subscriber.

A completed response goes to the form's sinks: the event stream, the CRM, the forwarding address, the welcome mail and the webhooks.

429 past the platform's rate for one address, 413 past its body bound, 400 for a body that does not decode, a field no person fills, or any problem with the answers (every one named), 404 for a form that is not published.

Request

18 fields, body application/json (required).

Response

201 body — 8 fields.

Failure carries the platform error shape — see Errors.

Examples

hanzo form public responses <id>

import { Configuration, FormApi } from 'hanzoai';

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.submitFormResponse({ id: 'id', answers: [{"boolean":false,"choices":["<choices>"],"date":"<date>","field":"<field>"}], completed: false });

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).submit_form_response(id='id', answers=[{"boolean":false,"choices":["<choices>"],"date":"<date>","field":"<field>"}], completed=False)

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

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

curl -X POST https://api.hanzo.ai/v1/form/public/<id>/responses \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "answers": [
         {
           "boolean": false,
           "choices": [
             "<choices>"
           ],
           "date": "<date>",
           "field": "<field>"
         }
       ],
       "completed": false
     }'

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": "submit_form_response",
           "input": {
             "id": "<id>",
             "answers": [
               {
                 "boolean": false,
                 "choices": [
                   "<choices>"
                 ],
                 "date": "<date>",
                 "field": "<field>"
               }
             ],
             "completed": false
           }
         }
       }
     }'

Form API · All Hanzo APIs · Interactive reference