v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB

Widgets

Update saved form

Update a saved form's name, audience targeting, copy, visual theme, or content blocks. Every field is optional - send only what should change.

The headline, description, buttonText, and successMessage fields edit the matching content block and fail with 400 when the form has no such block; replace blocks for structural changes. The blocks array fully replaces the form's content blocks and must keep exactly one email field and one submit button. An empty redirectUrl switches the form back to its confirmation message.

patch/forms/{companyIdOrFormId}

Path parameters

companyIdOrFormIdstring required

The saved form ID to update

Request body

namestring

listIdsstring[]

tagIdsstring[]

Replacement tag IDs. An empty array clears tags.

duplicateStrategy'skip' | 'merge' | 'overwrite'

headlinestring

descriptionstring

buttonTextstring

successMessagestring

redirectUrlstring

HTTP or HTTPS success redirect. An empty string switches back to the confirmation message.

themeobject

Visual theme overrides merged into the current theme (accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor as "#rrggbb", borderRadius 0-32, headingFontFamily, bodyFontFamily, density).

blocksobject[]

Full replacement for the form's content blocks.

Response

Form updated

successboolean

formobject

embedobject

Embed recipes, present when the form is published.

messagestring

Example response

{
  "success": true
}