USuseboom
Lead Capture

Update an embedded form

Changed on

Edit an embedded form’s draft, replace its allowed sites, or set it ACTIVE or PAUSED. Draft edits reach visitors only when published.

patch/api/v1/lead-capture/embedded-forms/{formId}

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

formIdstring required

Form id.

Request body

draftobject

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.

allowedOriginsstring[]

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.

status'PAUSED' | 'ACTIVE'

ACTIVE needs a published version and at least one site.

Response

Success

idstring required
namestring required
status'PAUSED' | 'ACTIVE' required
allowedOriginsstring[] required
installKeystring required

Public; identifies the form in the embed.

publishedVersionnumber nullable required

The version visitors get; null until first published.

unpublishedChangesboolean required

The draft differs from the published version.

updatedAtstring required
embedTagstring required

Paste where the form should appear, together with installTag.

installTagstring required
draftobject required

The editable config: steps, fields (typed questions with key, options[].value, score, sensitive), endings (with score ranges), consent, hidden, constants, partials (enabled, notice: keep what a visitor answered when they leave without submitting) 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.

publishIssuesstring[] required

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

Changes