Skip to main content
PATCH
Update an embedded form

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

formId
string
required

Form id.

Required string length: 1 - 64

Body

application/json
draft
object

Any part of the draft, laid over the current one: objects merge, lists (steps, fields, options, endings) are replaced whole, so send the full list. Published keys, types, answer values, the slug and the event name cannot change; publishing refuses that with the reasons.

allowedOrigins
string[]

Every site the pop-up may open on, as bare origins such as https://www.example.com. Matching is exact: https://example.com does not cover https://www.example.com.

Maximum array length: 20
status
enum<string>

ACTIVE needs a published version and at least one site.

Available options:
PAUSED,
ACTIVE

Response

Success

id
string
required
name
string
required
status
enum<string>
required
Available options:
PAUSED,
ACTIVE
allowedOrigins
string[]
required
installKey
string
required

Public; identifies the form in the embed.

publishedVersion
number | null
required

The version visitors get; null until first published.

unpublishedChanges
boolean
required

The draft differs from the published version.

updatedAt
string
required
embedTag
string
required

Paste where the form should appear, together with installTag.

installTag
string
required
draft
object
required

The editable config: steps, fields (typed questions with key, options[].value, score, sensitive), endings (with score ranges), consent, hidden, constants and design. Edit it and send it back as draft to lead_capture_embedded_forms_update; lists are replaced whole. Visitors see nothing until lead_capture_embedded_forms_publish.

publishIssues
string[]
required

Why the draft cannot be published yet; empty when it can.