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.

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.

collectEmail?boolean

Defaultfalse

emailRequired?boolean

Defaultfalse

thankYouMessage?string

Lengthlength <= 1000

redirectUrl?string

Formaturi

showProgress?boolean

Defaulttrue

useCase?string

Default"forms"

Value in

"forms"
"hackathons"
"retros"
"hr_pulse"

layout?string

Default"single_page"

Value in

"single_page"
"multistep"
"conversational"
"card"

[key: string]?any

Response Body

`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"    }  }}

{  "error": "string",  "issues": [    {      "path": [        null      ],      "message": "string"    }  ]}

{  "error": "string"}

{  "error": "string"}

{  "error": "string"}

{  "error": "string"}

{  "error": "string"}

Update a form's respondent-experience settings

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`