OratoraDocs
APIReferenceForms

Update a form's respondent-experience settings

Replaces the form's settings object (collectEmail, redirectUrl, layout, and similar). Omitted fields fall back to their defaults.

PATCH
/forms/{id}/settings

Replaces the form's settings object (collectEmail, redirectUrl, layout, and similar). Omitted fields fall back to their defaults.

Authorization

ApiKey
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Form id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/forms/string/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "form": {    "id": "string",    "settings": {      "collectEmail": false,      "emailRequired": false,      "thankYouMessage": "string",      "redirectUrl": "http://example.com",      "showProgress": true,      "useCase": "forms",      "layout": "single_page"    }  }}

Delete a form

Deletes a form along with all of its fields and responses.

Publish a form

Publishes a form so it starts accepting responses. Requires at least one field.