USuseboom
Lead Capture

Create a Lead Capture pop-up

Changed on

Create a pop-up, PAUSED, optionally from a template. Then add prizes and codes with lead_capture_forms_update, and set it ACTIVE there once lead_capture_forms_get shows no liveIssues. Visitors see nothing until it is ACTIVE and the install tag is on an allowed site.

post/api/v1/lead-capture/forms

Request

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

Request body

namestring required

Internal name, unique in the organization. Not shown to visitors.

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

A finished starting point: look, image, words and game. bold_coupon, warm_newsletter (email only), midnight and editorial (a yes/no screen, the code sent by message) have no game; wheel, cards, plinko and scratch are games and need prizes before going live.

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.

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