chatformdocs
API referenceV1

Every setting a form has, by key, with its current value

The settings you can change with `PATCH /v1/forms/{id}/settings`: colours and fonts, the interviewer's tone and goal, who can respond, when the form closes, emails, sharing and embedding. Each carries the builder's label, where it lives in the builder, the values it takes, and `locked` when your plan does not include it.

GET
/v1/forms/{id}/settings

Authorization

AuthorizationBearer <token>

A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/forms/string/settings"
{  "settings": [    {      "key": "string",      "section": "string",      "sectionLabel": "string",      "label": "string",      "where": "string",      "format": "string",      "options": [        {          "value": "string",          "label": "string"        }      ],      "min": 0,      "max": 0,      "maxLength": 0,      "maxItems": 0,      "clearable": true,      "hint": "string",      "value": null,      "locked": {        "feature": "string",        "plan": "string"      },      "property1": null,      "property2": null    }  ]}