USuseboom
Lead Capture

Create an embedded form

Changed on

Create an embedded form, PAUSED and unpublished. Edit its draft with lead_capture_embedded_forms_update, publish it with lead_capture_embedded_forms_publish, then set it ACTIVE. Visitors see nothing until it is published, ACTIVE, and embedded on an allowed site.

post/api/v1/lead-capture/embedded-forms

Request

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

Request body

namestring required

Internal name, unique in the organization.

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.

draftobject

A full starting config (see lead_capture_embedded_forms_get). Omitted: one email question and a thank-you ending, the slug taken from the name. Set language.default (en, es or pt) to the language the copy is written in: publishing checks the required text in it.

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