chatformdocs
API referenceV1

Change a form's settings by key

Changes the working document; nothing is live until `POST /v1/forms/{id}/publish`. Every value is checked: one that does not parse is listed in `rejected` with the reason and nothing else in the call is held back. A setting your plan does not include comes back in `changes` with `locked` and is not applied. 422 when nothing in the call could be applied.

PATCH
/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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/forms/string/settings" \  -H "Content-Type: application/json" \  -d '{    "changes": [      {        "key": "string",        "value": "string"      }    ]  }'
{  "changes": [    {      "key": "string",      "section": "string",      "label": "string",      "where": "string",      "format": "string",      "before": null,      "after": null,      "locked": {        "feature": "string"      },      "property1": null,      "property2": null    }  ],  "rejected": [    "string"  ]}

Delivery queue status: pending, failed and delivered in the last 24 hours, per endpoint

Previous Page

Rename a payment account, or make it the default

`label` sets the name the account is shown under in the builder. `isDefault: true` makes it the account new verified-checkout questions start on. Nothing changes at the gateway.