USuseboom
Lead Capture

Update a Lead Capture pop-up

Changed on

Change a pop-up: restyle it with a template, edit any part of its config (design, copy, fields, trigger, game, prizes and codes), replace its allowed sites, or set it ACTIVE or PAUSED. A live pop-up must stay ready, so a change that would break it is refused with the reasons. Visitors see a change within about five minutes.

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

Request

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

Path parameters

formIdstring required

Pop-up id.

Request body

template'bold_coupon' | 'warm_newsletter' | 'midnight' | 'editorial' | 'wheel' | 'cards' | 'plinko' | 'scratch'

Restyle with a template first: its look, image, words and game, keeping the prizes, trigger, logo and phone country. config then applies on top.

configobject

Any part of the config from lead_capture_forms_get, merged into the current one: objects merge key by key, while a list (such as prizes) or a plain value replaces what was there. A field the config does not have is refused, so check the spelling. Example: { "copy": { "headline": { "en": "Spin to win", "es": "Gira y gana" } }, "prizes": [{ "id": "p10", "label": { "en": "10% off" }, "code": "SAVE10", "weight": 1 }] }.

allowedOriginsstring[]

Replaces the whole list of allowed sites.

status'PAUSED' | 'ACTIVE'

ACTIVE shows it to visitors on the allowed sites; it is refused, with the reasons, until the pop-up is ready (at least one site, a prize per game, consent text for a phone).

Response

Success

idstring required
namestring required
status'PAUSED' | 'ACTIVE' required

ACTIVE shows it to visitors on the allowed sites; it is refused, with the reasons, until the pop-up is ready (at least one site, a prize per game, consent text for a phone).

gamestring required

The game, or none for a plain form.

allowedOriginsstring[] required
installKeystring required

Public; identifies the pop-up in the install tag.

updatedAtstring required

ISO timestamp.

installTagstring required

The script tag to paste at the end of the page body.

buttonTagstring required

A button that opens the pop-up when clicked, whatever its trigger; with the trigger set to click it is the only way it opens. The install tag must be on the page too.

configobject required

The full design, copy, fields, trigger, game and prizes. Send any part of it back as config to lead_capture_forms_update. Text fields are { "en": "…", "es": "…", "pt": "…" }; en is required. flow.order is form-first (details, then the game) or play-first (the game, then details to claim the prize; needs a game). If the stored settings could no longer be read, this shows the defaults and liveIssues says so; a patch then starts from the defaults.

liveIssuesstring[] required

Why it could not go live as it stands, one field: reason per line. Empty when it is ready.

Changes