Vai al contenuto
Docs

Crea moduli di iscrizione, pubblicali e ruota il loro token pubblico.

URL di basehttps://api.emailit.com/v2AutenticazioneErroriLimiti di frequenza

Crea un modulo

Crea un modulo di iscrizione nello stato draft con un token pubblico. Richiede una chiave API full. I moduli sono in accesso anticipato.

Se ometti definition, Emailit genera un modulo iniziale: un passaggio con un titolo, un campo email obbligatorio e un pulsante Subscribe, più un passaggio di conferma. Crea e personalizza i moduli nel pannello in Email MarketingForms, poi pubblicali.

POST/forms

Parametri del corpo

namestringobbligatorio
Nome del modulo. I visitatori non lo vedono.
typestringpredefinito: popup
Come appare il modulo: popup, full_page, flyout, embed o banner.
definitionobject

Il contenuto del modulo, salvato così com’è. Emailit lo controlla solo quando pubblichi. Campi di primo livello:

  • version (integer): 1.
  • type (string): il tipo di modulo.
  • steps (array): ogni passaggio ha id, name, kind (form o success) e blocks. I blocchi hanno un id e un type: text, button (action: submit, next, close o go_to_url), image, oppure un campo di input (email, text_input, phone, date, radio, checkbox, dropdown) con name, label e required del campo.
  • styles, targeting, experiments (oggetti): regole di aspetto e di visualizzazione impostate dall’editor dei moduli.
settingsobject
Impostazioni libere salvate con il modulo. Il valore predefinito è {}.

Restituisce

Restituisce 201 Created con l’oggetto modulo, compresi definition e settings.

tokenstring
Token pubblico che lo script di incorporamento usa per caricare il modulo. Vedi Installa i moduli sul tuo sito.
statusstring
draft finché non pubblichi il modulo, poi live.
published_atstring | null
Quando il modulo è stato pubblicato l’ultima volta.

Restituisce 400 se name manca o è vuoto, oppure se type non è uno dei valori consentiti.

POST/forms
Terminal
curl -X POST https://api.emailit.com/v2/forms \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Newsletter popup", "type": "popup" }'
JSON
{
  "object": "form",
  "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
  "name": "Newsletter popup",
  "type": "popup",
  "status": "draft",
  "token": "9636697db6c8f136d6742cee9c86eb3ed53b89f0a44e3ce6",
  "created_at": "2026-10-01T11:20:31.000000+00:00",
  "updated_at": "2026-10-01T11:20:31.000000+00:00",
  "published_at": null,
  "definition": {
    "version": 1,
    "type": "popup",
    "steps": [
      {
        "id": "3Rb7Lq2NcX9vZt4Wm8Kd1Hs6PyE",
        "name": "Step 1",
        "kind": "form",
        "blocks": [
          { "id": "3Rb7Lq5TgB2kVw7Nn1Ps4Fd9QzA", "type": "text", "content": "<p>Join our list</p>" },
          {
            "id": "3Rb7Lq3JfM6xYc0Rr5Hh8Gk2SeU",
            "type": "email",
            "label": "<p>Email</p>",
            "placeholder": "you@example.com",
            "required": true,
            "name": "email"
          },
          { "id": "3Rb7Lq4WdP1zQa6Ee9Jj3Lm7TfV", "type": "button", "label": "<p>Subscribe</p>", "action": "submit" }
        ]
      },
      {
        "id": "3Rb7Lq2XkS8wUe3Tt6Mn0Bv5RgC",
        "name": "Success",
        "kind": "success",
        "blocks": [
          { "id": "3Rb7Lq6YhD4cFi9Uu2Oo7Cx1WhB", "type": "text", "content": "<p>Thanks for subscribing!</p>" }
        ]
      }
    ],
    "styles": {
      "backgroundColor": "#ffffff",
      "textColor": "#0f172a",
      "primaryColor": "#03a071",
      "borderRadius": 12,
      "fontFamily": "Inter, system-ui, sans-serif",
      "buttonStyle": "solid"
    },
    "targeting": {},
    "experiments": {}
  },
  "settings": {}
}

Recupera un modulo

Recupera un modulo con la sua definizione completa. Richiede una chiave API full.

GET/forms/{id}

Parametri di percorso

idstringobbligatorio
L’ID del modulo (frm_…).

Restituisce

Restituisce l’oggetto modulo.

objectstring
Sempre form.
idstring
ID del modulo, con prefisso frm_.
namestring
Nome del modulo.
typestring
popup, full_page, flyout, embed o banner.
statusstring
draft o live. Solo i moduli live vengono caricati sul tuo sito.
tokenstring
Token pubblico usato dallo script di incorporamento.
definitionobject
Passaggi, blocchi, stili e targeting. Vedi Crea un modulo.
settingsobject
Impostazioni libere.
created_at, updated_at, published_atstring | null
Timestamp in UTC. published_at è null fino alla prima pubblicazione.

Restituisce 404 se il modulo non esiste.

GET/forms/{id}
Terminal
curl https://api.emailit.com/v2/forms/frm_3Bzpif9xswMlVbFvGZSPNixm5j5 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "object": "form",
  "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
  "name": "Newsletter popup",
  "type": "popup",
  "status": "live",
  "token": "9636697db6c8f136d6742cee9c86eb3ed53b89f0a44e3ce6",
  "created_at": "2026-10-01T11:20:31.000000+00:00",
  "updated_at": "2026-10-01T11:48:02.000000+00:00",
  "published_at": "2026-10-01T11:48:02.000000+00:00",
  "definition": {
    "version": 1,
    "type": "popup",
    "steps": [
      {
        "id": "3Rb7Lq2NcX9vZt4Wm8Kd1Hs6PyE",
        "name": "Step 1",
        "kind": "form",
        "blocks": [
          { "id": "3Rb7Lq5TgB2kVw7Nn1Ps4Fd9QzA", "type": "text", "content": "<p>Get our monthly product notes</p>" },
          {
            "id": "3Rb7Lq3JfM6xYc0Rr5Hh8Gk2SeU",
            "type": "email",
            "label": "<p>Email</p>",
            "placeholder": "you@example.com",
            "required": true,
            "name": "email"
          },
          { "id": "3Rb7Lq4WdP1zQa6Ee9Jj3Lm7TfV", "type": "button", "label": "<p>Subscribe</p>", "action": "submit" }
        ]
      },
      {
        "id": "3Rb7Lq2XkS8wUe3Tt6Mn0Bv5RgC",
        "name": "Success",
        "kind": "success",
        "blocks": [
          { "id": "3Rb7Lq6YhD4cFi9Uu2Oo7Cx1WhB", "type": "text", "content": "<p>Thanks for subscribing!</p>" }
        ]
      }
    ],
    "styles": {
      "backgroundColor": "#ffffff",
      "textColor": "#0f172a",
      "primaryColor": "#03a071",
      "borderRadius": 12,
      "fontFamily": "Inter, system-ui, sans-serif",
      "buttonStyle": "solid"
    },
    "targeting": {},
    "experiments": {}
  },
  "settings": {}
}

Aggiorna un modulo

Aggiorna i campi che passi e lascia invariati gli altri. Richiede una chiave API full.

Le modifiche a un modulo live sono subito visibili ai visitatori; non è necessario pubblicarlo di nuovo. Per modificarlo senza effetti sui visitatori, prima ritiralo.

POST/forms/{id}

Parametri di percorso

idstringobbligatorio
L’ID del modulo (frm_…).

Parametri del corpo

namestring
Nuovo nome. Non può essere vuoto.
typestring
popup, full_page, flyout, embed o banner. Aggiorna definition.type di conseguenza.
definitionobject
Sostituisce l’intera definizione. Per la sua struttura, vedi Crea un modulo.
settingsobject
Sostituisce l’oggetto delle impostazioni.

Restituisce

Restituisce l’oggetto modulo aggiornato. Restituisce 400 se un campo ha il tipo sbagliato o name è vuoto, e 404 se il modulo non esiste.

POST/forms/{id}
Terminal
curl -X POST https://api.emailit.com/v2/forms/frm_3Bzpif9xswMlVbFvGZSPNixm5j5 \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Newsletter popup (October)" }'
JSON
{
  "object": "form",
  "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
  "name": "Newsletter popup (October)",
  "type": "popup",
  "status": "live",
  "token": "9636697db6c8f136d6742cee9c86eb3ed53b89f0a44e3ce6",
  "created_at": "2026-10-01T11:20:31.000000+00:00",
  "updated_at": "2026-10-02T08:05:14.000000+00:00",
  "published_at": "2026-10-01T11:48:02.000000+00:00",
  "definition": {
    "version": 1,
    "type": "popup",
    "steps": [
      {
        "id": "3Rb7Lq2NcX9vZt4Wm8Kd1Hs6PyE",
        "name": "Step 1",
        "kind": "form",
        "blocks": [
          { "id": "3Rb7Lq3JfM6xYc0Rr5Hh8Gk2SeU", "type": "email", "label": "<p>Email</p>", "required": true, "name": "email" },
          { "id": "3Rb7Lq4WdP1zQa6Ee9Jj3Lm7TfV", "type": "button", "label": "<p>Subscribe</p>", "action": "submit" }
        ]
      },
      {
        "id": "3Rb7Lq2XkS8wUe3Tt6Mn0Bv5RgC",
        "name": "Success",
        "kind": "success",
        "blocks": [{ "id": "3Rb7Lq6YhD4cFi9Uu2Oo7Cx1WhB", "type": "text", "content": "<p>Thanks for subscribing!</p>" }]
      }
    ],
    "styles": { "primaryColor": "#03a071", "borderRadius": 12, "buttonStyle": "solid" },
    "targeting": {},
    "experiments": {}
  },
  "settings": {}
}

Elenca i moduli

Restituisce i moduli del workspace, a partire dal più recente, senza definition e settings. Richiede una chiave API full.

GET/forms

Parametri di query

pageintegerpredefinito: 1
Numero della pagina, a partire da 1.
limitintegerpredefinito: 10
Moduli per pagina, da 1 a 100.
matchstring

all (predefinito) richiede che corrispondano tutti i filtri. or richiede che ne corrisponda almeno uno. Vedi Filtri e ordinamento.

orderstring

Chiave di ordinamento di questo elenco. Vedi le chiavi di ordinamento qui sotto.

directionstring

asc o desc.

Chiavi di filtro

I filtri usano parametri di query key.condition=value, ad esempio status.exact=live. Vedi Filtri e ordinamento.

Chiave Tipo Note
name string
type enum popup, full_page, flyout, embed, banner
status enum draft, live
created_at date

Chiavi di ordinamento per order: name, type, status, created_at.

Restituisce

dataobject[]
I moduli di questa pagina: object, id, name, type, status, token, created_at, updated_at, published_at.
total_recordsinteger
Numero di moduli che corrispondono alla query.
next_page_urlstring | null
Percorso della pagina successiva, oppure null sull’ultima pagina. Contiene solo page e limit; quando lo segui, aggiungi di nuovo la ricerca e i filtri.
previous_page_urlstring | null
Percorso della pagina precedente, oppure null sulla prima pagina.
GET/forms
Terminal
curl -G https://api.emailit.com/v2/forms \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -d status.exact=live
JSON
{
  "data": [
    {
      "object": "form",
      "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
      "name": "Newsletter popup",
      "type": "popup",
      "status": "live",
      "token": "9636697db6c8f136d6742cee9c86eb3ed53b89f0a44e3ce6",
      "created_at": "2026-10-01T11:20:31.000000+00:00",
      "updated_at": "2026-10-01T11:48:02.000000+00:00",
      "published_at": "2026-10-01T11:48:02.000000+00:00"
    }
  ],
  "total_records": 1,
  "next_page_url": null,
  "previous_page_url": null
}

Pubblica un modulo

Imposta lo stato del modulo su live e aggiorna published_at. I moduli live vengono caricati su qualsiasi sito in cui è installato lo script di Emailit e possono ricevere risposte. Richiede una chiave API full.

La definizione deve avere almeno un passaggio con kind: "form" e uno con kind: "success"; altrimenti la richiesta restituisce 422. Le risposte vengono salvate con il modulo e per ora non creano contatti.

POST/forms/{id}/publish

Parametri di percorso

idstringobbligatorio
L’ID del modulo (frm_…).

Restituisce

Restituisce l’oggetto modulo con status impostato su live. Restituisce 422 se la definizione è incompleta e 404 se il modulo non esiste.

POST/forms/{id}/publish
Terminal
curl -X POST https://api.emailit.com/v2/forms/frm_3Bzpif9xswMlVbFvGZSPNixm5j5/publish \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "object": "form",
  "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
  "name": "Newsletter popup",
  "type": "popup",
  "status": "live",
  "token": "9636697db6c8f136d6742cee9c86eb3ed53b89f0a44e3ce6",
  "created_at": "2026-10-01T11:20:31.000000+00:00",
  "updated_at": "2026-10-01T11:48:02.000000+00:00",
  "published_at": "2026-10-01T11:48:02.000000+00:00",
  "definition": {
    "version": 1,
    "type": "popup",
    "steps": [
      {
        "id": "3Rb7Lq2NcX9vZt4Wm8Kd1Hs6PyE",
        "name": "Step 1",
        "kind": "form",
        "blocks": [
          { "id": "3Rb7Lq3JfM6xYc0Rr5Hh8Gk2SeU", "type": "email", "label": "<p>Email</p>", "required": true, "name": "email" },
          { "id": "3Rb7Lq4WdP1zQa6Ee9Jj3Lm7TfV", "type": "button", "label": "<p>Subscribe</p>", "action": "submit" }
        ]
      },
      {
        "id": "3Rb7Lq2XkS8wUe3Tt6Mn0Bv5RgC",
        "name": "Success",
        "kind": "success",
        "blocks": [{ "id": "3Rb7Lq6YhD4cFi9Uu2Oo7Cx1WhB", "type": "text", "content": "<p>Thanks for subscribing!</p>" }]
      }
    ],
    "styles": { "primaryColor": "#03a071", "borderRadius": 12, "buttonStyle": "solid" },
    "targeting": {},
    "experiments": {}
  },
  "settings": {}
}

Ritira un modulo

Riporta lo stato del modulo a draft. Lo script di incorporamento smette di caricarlo e le nuove risposte vengono rifiutate. Il token, la definizione e published_at restano invariati, quindi puoi pubblicarlo di nuovo in seguito. Richiede una chiave API full.

POST/forms/{id}/unpublish

Parametri di percorso

idstringobbligatorio
L’ID del modulo (frm_…).

Restituisce

Restituisce l’oggetto modulo con status impostato su draft. Restituisce 404 se il modulo non esiste.

POST/forms/{id}/unpublish
Terminal
curl -X POST https://api.emailit.com/v2/forms/frm_3Bzpif9xswMlVbFvGZSPNixm5j5/unpublish \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "object": "form",
  "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
  "name": "Newsletter popup",
  "type": "popup",
  "status": "draft",
  "token": "9636697db6c8f136d6742cee9c86eb3ed53b89f0a44e3ce6",
  "created_at": "2026-10-01T11:20:31.000000+00:00",
  "updated_at": "2026-10-06T07:30:00.000000+00:00",
  "published_at": "2026-10-01T11:48:02.000000+00:00",
  "definition": {
    "version": 1,
    "type": "popup",
    "steps": [
      {
        "id": "3Rb7Lq2NcX9vZt4Wm8Kd1Hs6PyE",
        "name": "Step 1",
        "kind": "form",
        "blocks": [
          { "id": "3Rb7Lq3JfM6xYc0Rr5Hh8Gk2SeU", "type": "email", "label": "<p>Email</p>", "required": true, "name": "email" },
          { "id": "3Rb7Lq4WdP1zQa6Ee9Jj3Lm7TfV", "type": "button", "label": "<p>Subscribe</p>", "action": "submit" }
        ]
      },
      {
        "id": "3Rb7Lq2XkS8wUe3Tt6Mn0Bv5RgC",
        "name": "Success",
        "kind": "success",
        "blocks": [{ "id": "3Rb7Lq6YhD4cFi9Uu2Oo7Cx1WhB", "type": "text", "content": "<p>Thanks for subscribing!</p>" }]
      }
    ],
    "styles": { "primaryColor": "#03a071", "borderRadius": 12, "buttonStyle": "solid" },
    "targeting": {},
    "experiments": {}
  },
  "settings": {}
}

Reimposta il token pubblico

Genera un nuovo token pubblico per il modulo. Il vecchio token smette subito di funzionare: i siti che caricano il modulo con quel token non lo mostrano più e non possono inviargli risposte. Aggiorna il codice di incorporamento con il nuovo token. Richiede una chiave API full.

POST/forms/{id}/reset-token

Parametri di percorso

idstringobbligatorio
L’ID del modulo (frm_…).

Restituisce

Restituisce l’oggetto modulo con il nuovo token. Lo stato non cambia. Restituisce 404 se il modulo non esiste.

POST/forms/{id}/reset-token
Terminal
curl -X POST https://api.emailit.com/v2/forms/frm_3Bzpif9xswMlVbFvGZSPNixm5j5/reset-token \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "object": "form",
  "id": "frm_3Bzpif9xswMlVbFvGZSPNixm5j5",
  "name": "Newsletter popup",
  "type": "popup",
  "status": "live",
  "token": "e5ed3f9ec299ae1c5dc043c45f2a616c352e47a13b6b763b",
  "created_at": "2026-10-01T11:20:31.000000+00:00",
  "updated_at": "2026-10-06T09:12:44.000000+00:00",
  "published_at": "2026-10-01T11:48:02.000000+00:00",
  "definition": {
    "version": 1,
    "type": "popup",
    "steps": [
      {
        "id": "3Rb7Lq2NcX9vZt4Wm8Kd1Hs6PyE",
        "name": "Step 1",
        "kind": "form",
        "blocks": [
          { "id": "3Rb7Lq3JfM6xYc0Rr5Hh8Gk2SeU", "type": "email", "label": "<p>Email</p>", "required": true, "name": "email" },
          { "id": "3Rb7Lq4WdP1zQa6Ee9Jj3Lm7TfV", "type": "button", "label": "<p>Subscribe</p>", "action": "submit" }
        ]
      },
      {
        "id": "3Rb7Lq2XkS8wUe3Tt6Mn0Bv5RgC",
        "name": "Success",
        "kind": "success",
        "blocks": [{ "id": "3Rb7Lq6YhD4cFi9Uu2Oo7Cx1WhB", "type": "text", "content": "<p>Thanks for subscribing!</p>" }]
      }
    ],
    "styles": { "primaryColor": "#03a071", "borderRadius": 12, "buttonStyle": "solid" },
    "targeting": {},
    "experiments": {}
  },
  "settings": {}
}

Elimina un modulo

Elimina definitivamente un modulo e tutte le sue risposte salvate. I siti che lo incorporano smettono di mostrarlo. Richiede una chiave API full.

DELETE/forms/{id}

Parametri di percorso

idstringobbligatorio
L’ID del modulo (frm_…).

Restituisce

Restituisce 204 No Content con un corpo vuoto. Restituisce 404 se il modulo non esiste.

DELETE/forms/{id}
Terminal
curl -X DELETE https://api.emailit.com/v2/forms/frm_3Bzpif9xswMlVbFvGZSPNixm5j5 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
Text
(empty body)

Questa pagina ti è stata utile?

Grazie del feedback.

Grazie, leggiamo ogni messaggio.