Forms

Sign-up forms (double opt-in): builder settings, embed code, history.

Technická reference je anglicky (stejně jako strojově čitelný dokument OpenAPI). Celou skupinu pro AI agenta načtete z /api/openapi.json?tag=Forms.

Přihlášení: Authorization: Bearer pst_... nebo HTTP Basic (e-mail člena firmy a API klíč).

Operace#

List forms#

GET /api/v1/tenants/{tenant}/forms

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: list_forms

Sign-up forms (classic or popup).

Parametry

Odpovědi

• 200 OK: application/json object

Chyby

Create a form#

POST /api/v1/tenants/{tenant}/forms

Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: create_form

Creates a double opt-in sign-up form.

Parametry

Tělo požadavku (application/json)

Odpovědi

• 201 Created: application/json FormDetail

Chyby

List templates usable as the double opt-in e-mail#

GET /api/v1/tenants/{tenant}/forms/doi-templates

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full

E-mail templates with the confirmation link ({{confirmlink}}) a form may send as its double opt-in.

Parametry

Odpovědi

• 200 OK: application/json object

Chyby

Render a form preview#

POST /api/v1/tenants/{tenant}/forms/preview

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json object

Chyby

Change labels of forms#

POST /api/v1/tenants/{tenant}/forms/tags

Oprávnění: modul content, úroveň full; klíč s přístupem full

Parametry

Tělo požadavku (application/json): Required by the server: ids.

Odpovědi

• 200 OK: application/json object

Chyby

Get a form#

GET /api/v1/tenants/{tenant}/forms/{form_id}

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_form

One form with its fields, consent text and public address.

Parametry

Odpovědi

• 200 OK: application/json FormDetail

Chyby

Update a form#

PATCH /api/v1/tenants/{tenant}/forms/{form_id}

Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: update_form

Changes a form.

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json FormDetail

Chyby

Delete a form#

DELETE /api/v1/tenants/{tenant}/forms/{form_id}

Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: delete_form (přes MCP jen s náhledem a potvrzením)

Deletes a form (its address stops working).

Parametry

Odpovědi

• 204 No content

Chyby

Copy a form#

POST /api/v1/tenants/{tenant}/forms/{form_id}/copy

Oprávnění: modul content, úroveň full; klíč s přístupem full

Vytvořit kopii formuláře: an inactive copy with a free name.

Parametry

Tělo požadavku (application/json)

object

Odpovědi

• 201 Created: application/json FormDetail

Chyby

Get the embed code of a form#

GET /api/v1/tenants/{tenant}/forms/{form_id}/embed

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full

The codes of Vložit do stránky: script (JavaScript, always current), url (Odkaz na webový formulář), styled (HTML), html (Minimální HTML).

Parametry

Odpovědi

• 200 OK: application/json FormEmbed

Chyby

Change history of a form#

GET /api/v1/tenants/{tenant}/forms/{form_id}/history

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full

Historie vyplnění: the sign-ups of a form, newest first (?q= address, ?filledFrom= and ?filledTo= calendar days of the tenant, ?page=, ?pageSize=, ?sort=).

Parametry

Odpovědi

• 200 OK: application/json object

Chyby

Get the e-mail after a sign-up (the form's own automation)#

GET /api/v1/tenants/{tenant}/forms/{form_id}/welcome

Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full

E-mail po přihlášení (core/form_welcome.py): the form's own automation and its e-mail, the coupon tags of the template (?templateId= another template to check before saving) and the shop's coupon stacks.

Parametry

Odpovědi

• 200 OK: application/json FormWelcome

Chyby

Switch the e-mail after a sign-up on or off#

PUT /api/v1/tenants/{tenant}/forms/{form_id}/welcome

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Switches the e-mail after a sign-up on (creates or adopts the form's automation, saves its e-mail and starts it) or off (pauses it). Module campaigns: it runs an automation.

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json FormWelcome

Chyby

Schémata#

AutomationStatus#

one of: active, draft, paused

DoiTemplate#

An e-mail template with {{confirmlink}} a form may send as its double opt-in.

Error#

{
  "error": {
    "code": "validation",
    "message": "email"
  }
}

FormDesign#

Vzhled (step 2): core/form_builder.py DESIGN_DEFAULTS.

FormDetail#

FormEmbed#

FormExtraPurpose#

FormField#

FormFieldName#

FormFieldName

FormFill#

A sign-up of Historie vyplnění.

FormFont#

one of: arial, verdana, tahoma, trebuchet, georgia, times, courier

FormInput#

FormKind#

one of: classic, popup, slide

FormSettings#

Nastavení (step 3) and Přiřadit účely zpracování: core/form_builder.py SETTINGS_DEFAULTS.

FormSummary#

FormTemplate#

one of: classic, popup, slide, popup-image, popup-image-aside, slide-image

FormWelcome#

E-mail po přihlášení (core/form_welcome.py): the form's own automation (trigger form_submitted of the form, each contact once, one send_email node).

FormWelcomeInput#

FormWelcomeStack#

A coupon stack offered for E-mail po přihlášení (its tag in the template gives every subscriber one code).

GridTagsInput#

Bulk label change: add and remove, or tags = the new labels of every row.

PopupAfter#

one of: redirect, thanks, close

PopupRepeat#

one of: days, session, browser

PopupSettings#

Settings of a pop-up or slide-in form (core/form_popup.py).

PopupTrigger#

one of: load, delay, scroll