Liste

Gestisci le liste di iscritti usate da campagne e moduli di iscrizione.

URL di basehttps://api.emailit.com/v2Autenticazione Errori Limiti di frequenza

POST/audiences
GET/audiences/{id}
POST/audiences/{id}
GET/audiences
POST/audiences/{id}/merge
POST/audiences/bulk
DEL/audiences/{id}

Crea una lista

Crea una lista vuota.

POST/audiences

Richiede una chiave API full. Aggiungi persone con Aggiungi un iscritto, oppure passando l’ID della lista in audiences quando crei un contatto. Genera un evento audience.created. Vedi Liste.

Parametri del corpo

namestringobbligatorio

Il nome della lista, ad esempio Newsletter. Deve essere univoco nel workspace.

visibilitystringpredefinito: private

public mostra la lista a tutti nella pagina di gestione delle iscrizioni; private solo alle persone iscritte.

public_namestring | null

Il nome che gli iscritti vedono nelle email e nelle pagine per i destinatari. Fino a 120 caratteri. Con null viene mostrato name.

public_descriptionstring | null

Una riga mostrata nella pagina di gestione delle iscrizioni. Fino a 500 caratteri.

double_opt_inboolean | object

true o false, oppure un oggetto con uno o più tra enabled, redirect_url (un URL http(s) a cui vanno le persone dopo la conferma, oppure null) ed email. email accetta from, reply_to, subject, design (default o custom), heading, body, button_label e footer. I campi che ometti mantengono il valore memorizzato. Per attivarlo serve un indirizzo from su un dominio di invio verificato. Vedi Double opt-in.

confirmation_emailboolean | object

true o false, oppure un oggetto con enabled ed email, che accetta gli stessi campi indicati sopra più button_url.

unengagedobject

exclude (salta gli iscritti inattivi nelle campagne) e days (da 30 a 1825).

Restituisce

Restituisce 201 con la nuova lista, comprese le sue impostazioni come descritte in Recupera una lista:

objectstring

Sempre audience.

idstring

L’ID della lista.

namestring

Il nome della lista.

tokenstring

Il token presente nell’URL di iscrizione della lista. Tienilo segreto.

visibilitystring

public o private.

created_atstring

Quando è stata creata la lista.

updated_atstring

Quando la lista è stata modificata l’ultima volta.

POST/audiences

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.create({
  name: 'Newsletter',
});

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.create({
  "name": "Newsletter"
})

PHP

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->create([
  'name' => 'Newsletter',
]);

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.create(name: "Newsletter")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Create(&emailit.CreateAudienceRequest{
  Name: "Newsletter",
})

Rust

use emailit::Emailit;
use emailit::types::CreateAudienceParams;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.create(
  CreateAudienceParams::new("Newsletter")
).await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().create(
  AudienceCreateParams.builder()
    .setName("Newsletter")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Create(new AudienceCreateOptions {
  Name = "Newsletter",
});

PHP

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->create([
  'name' => 'Newsletter',
]);

Terminal

curl -X POST https://api.emailit.com/v2/audiences \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Newsletter"}'

JSON

{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "visibility": "private",
  "public_name": null,
  "public_description": null,
  "double_opt_in": {
    "enabled": false,
    "redirect_url": null,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "Confirm your subscription to {{audience_name}}",
      "design": "default",
      "heading": "Please confirm your subscription",
      "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
      "button_label": "Confirm subscription",
      "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm.",
      "source": null
    }
  },
  "confirmation_email": {
    "enabled": false,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "You're subscribed to {{audience_name}}",
      "design": "default",
      "heading": "You're subscribed",
      "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
      "button_label": "",
      "button_url": "",
      "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
      "source": null
    }
  },
  "unengaged": { "exclude": false, "days": 365 },
  "archived": false,
  "archived_at": null,
  "subscribers_count": 0,
  "created_at": "2026-10-01T10:02:44.613207Z",
  "updated_at": "2026-10-01T10:02:44.613207Z"
}

JSON

{
  "error": "Audience with this name already exists",
  "existing": {
    "object": "audience",
    "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
    "name": "Newsletter",
    "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
    "subscribers_count": 0,
    "created_at": "2026-10-01T10:02:44.000000Z",
    "updated_at": "2026-10-01T10:02:44.000000Z"
  }
}

Recupera una lista

Recupera una lista con le sue impostazioni, i conteggi e il token pubblico.

GET/audiences/{id}

Richiede una chiave API full.

Parametri di percorso

idstringobbligatorio

L’ID della lista (aud_…) o il suo nome esatto, codificato per l’URL.

Restituisce

Restituisce l’oggetto lista.

objectstring

Sempre audience.

idstring

L’ID della lista.

namestring

Il nome della lista.

tokenstring

Il token presente nell’URL di iscrizione della lista. Tienilo segreto: chiunque lo abbia può aggiungere persone alla lista.

visibilitystring

public o private. Le liste pubbliche compaiono per tutti nella pagina di gestione delle iscrizioni; quelle private solo per le persone iscritte.

public_namestring | null

Il nome che vedono gli iscritti, oppure null per mostrare name.

public_descriptionstring | null

La descrizione mostrata nella pagina di gestione delle iscrizioni.

double_opt_inobject

enabled, redirect_url (dove vanno le persone dopo la conferma, oppure null) ed email, l’email di double opt-in con from, reply_to, subject, design (default o custom), heading, body, button_label, footer e source (l’MJML di un design personalizzato, oppure null; gli elenchi lo omettono). I campi che non hai mai impostato contengono i valori predefiniti.

confirmation_emailobject

enabled ed email, l’email di conferma, con gli stessi campi indicati sopra più button_url.

unengagedobject

exclude (se le campagne saltano gli iscritti inattivi) e days (il periodo, 365 per impostazione predefinita).

archivedboolean

Indica se la lista è archiviata. archived_at contiene la data e l’ora, oppure null.

subscribers_countinteger

Quanti contatti ci sono nella lista, compresi quelli disiscritti.

usageobject

used (lo stesso conteggio), limit (il numero massimo di iscritti che una lista può avere con il tuo piano, oppure null se non c’è limite) e plan. Vedi Limiti e quote.

unengaged_countinteger

Quante persone iscritte risultano inattive in questo momento.

pending_confirmations_countinteger

Quante richieste di double opt-in sono in attesa di un clic, escluse quelle scadute.

created_atstring

Quando è stata creata la lista.

updated_atstring

Quando la lista è stata modificata l’ultima volta.

GET/audiences/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.get('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2');

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2")

PHP

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->get('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2');

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2")

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2").await?;

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2");

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2");

PHP

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->get('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2');

Terminal

curl https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JSON

{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Newsletter",
  "visibility": "public",
  "public_name": "Monthly newsletter",
  "public_description": "Product news and tips, once a month.",
  "double_opt_in": {
    "enabled": true,
    "redirect_url": null,
    "email": {
      "from": "News <news@example.com>",
      "reply_to": null,
      "subject": "Confirm your subscription to {{audience_name}}",
      "design": "default",
      "heading": "Please confirm your subscription",
      "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
      "button_label": "Confirm subscription",
      "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm.",
      "source": null
    }
  },
  "confirmation_email": {
    "enabled": false,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "You're subscribed to {{audience_name}}",
      "design": "default",
      "heading": "You're subscribed",
      "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
      "button_label": "",
      "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
      "button_url": "",
      "source": null
    }
  },
  "unengaged": { "exclude": true, "days": 365 },
  "archived": false,
  "archived_at": null,
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "subscribers_count": 1284,
  "unengaged_count": 212,
  "pending_confirmations_count": 3,
  "usage": {
    "used": 1284,
    "limit": 50000,
    "plan": "pro"
  },
  "created_at": "2026-10-01T10:02:44.000000Z",
  "updated_at": "2026-10-01T10:02:44.000000Z"
}

JSON

{
  "error": "Audience not found"
}

Aggiorna una lista

Rinomina una lista o ne cambia le impostazioni.

POST/audiences/{id}

Richiede una chiave API full. Invia solo i campi che vuoi cambiare. L’ID, il token e gli iscritti non cambiano. Genera un evento audience.updated.

Parametri di percorso

idstringobbligatorio

L’ID della lista o il suo nome attuale.

Parametri del corpo

namestring

Il nuovo nome. Deve essere univoco nel workspace.

visibilitystring

public mostra la lista a tutti nella pagina di gestione delle iscrizioni; private solo alle persone iscritte.

public_namestring | null

Il nome che gli iscritti vedono nelle email e nelle pagine per i destinatari. Fino a 120 caratteri. Con null viene mostrato name.

public_descriptionstring | null

Una riga mostrata nella pagina di gestione delle iscrizioni. Fino a 500 caratteri.

double_opt_inboolean | object

confirmation_emailboolean | object

true o false, oppure un oggetto con enabled ed email, che accetta gli stessi campi indicati sopra più button_url.

unengagedobject

exclude (salta gli iscritti inattivi nelle campagne) e days (da 30 a 1825).

archivedboolean

true archivia la lista, false la toglie dall’archivio. Vedi Archivia una lista.

Impostare un design MJML personalizzato con email.source fa parte dell’alpha di MJML e, con le chiavi API, restituisce 403 con error: "mjml_alpha".

Restituisce

Restituisce la lista con le sue impostazioni, come in Recupera una lista. In questa risposta subscribers_count è sempre 0 e i conteggi sono omessi; per ottenerli usa Recupera una lista. Le impostazioni non valide restituiscono 422 con un oggetto errors indicizzato per campo, ad esempio double_opt_in.email.from.

POST/audiences/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audience = await emailit.audiences.update('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', {
  name: 'Weekly newsletter',
});

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audience = client.audiences.update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", {
  "name": "Weekly newsletter"
})

PHP

$emailit = Emailit::client('your_api_key');

$audience = $emailit->audiences()->update('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', [
  'name' => 'Weekly newsletter',
]);

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audience = client.audiences.update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", name: "Weekly newsletter")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audience, err := client.Audiences.Update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", &emailit.UpdateAudienceRequest{
  Name: "Weekly newsletter",
})

Rust

use emailit::Emailit;
use emailit::types::UpdateAudienceParams;

let emailit = Emailit::new("your_api_key");

let audience = emailit.audiences.update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", UpdateAudienceParams {
  name: Some("Weekly newsletter".into()),
  ..Default::default()
}).await?;

Java

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  AudienceUpdateParams.builder()
    .setName("Weekly newsletter")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audience = emailit.Audiences.Update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", new AudienceUpdateOptions {
  Name = "Weekly newsletter",
});

PHP

use Emailit\Laravel\Facades\Emailit;

$audience = Emailit::audiences()->update('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', [
  'name' => 'Weekly newsletter',
]);

Terminal

curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2 \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Weekly newsletter"}'

JSON

{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Weekly newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "visibility": "public",
  "public_name": "Weekly newsletter",
  "public_description": null,
  "double_opt_in": {
    "enabled": true,
    "redirect_url": null,
    "email": {
      "from": "News <news@example.com>",
      "reply_to": null,
      "subject": "Confirm your subscription to {{audience_name}}",
      "design": "default",
      "heading": "Please confirm your subscription",
      "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
      "button_label": "Confirm subscription",
      "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm.",
      "source": null
    }
  },
  "confirmation_email": {
    "enabled": false,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "You're subscribed to {{audience_name}}",
      "design": "default",
      "heading": "You're subscribed",
      "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
      "button_label": "",
      "button_url": "",
      "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
      "source": null
    }
  },
  "unengaged": {
    "exclude": false,
    "days": 365
  },
  "archived": false,
  "archived_at": null,
  "subscribers_count": 0,
  "created_at": "2026-10-01T10:02:44.000000Z",
  "updated_at": "2026-10-01T14:31:09.000000Z"
}

JSON

{
  "error": "No valid fields provided for update. Provide at least one of: name, visibility, public_name, public_description, double_opt_in, confirmation_email, unengaged, archived"
}

JSON

{
  "message": "Validation failed.",
  "errors": {
    "double_opt_in.email.from": ["Use an address on a verified sending domain of this workspace."]
  }
}

JSON

{
  "error": "Audience not found"
}

JSON

{
  "error": "Another audience with this name already exists"
}

Elenca le liste

Restituisce una pagina di liste, a partire dalla più recente. Le liste archiviate sono escluse, a meno che tu non le richieda.

GET/audiences

Richiede una chiave API full. Gli elementi dell’elenco non includono il token della lista; per ottenerlo usa Recupera una lista.

Parametri di query

pageintegerpredefinito: 1

La pagina da restituire.

limitintegerpredefinito: 10

Liste per pagina, da 1 a 100.

searchstring

Corrispondenza sul nome della lista, senza distinzione tra maiuscole e minuscole.

archivedstringpredefinito: false

false per le liste attive, true solo per quelle archiviate, all per entrambe.

visibilitystring

public o private per elencare solo quelle.

matchstringpredefinito: all

all o or. Come si combinano i filtri qui sotto.

orderstring

name, public_name, visibility, subscribers_count o created_at.

directionstring

asc o desc.

Filtri

Aggiungi i filtri nella forma key.condition=value, ad esempio name.contains=news. Vedi Filtri e ordinamento.

Chiave	Tipo
`name`	string
`public_name`	string
`visibility`	enum: `public`, `private`
`subscribers_count`	number
`created_at`	date

Restituisce

dataobject[]

Le liste di questa pagina, ciascuna con object, id, name, le impostazioni (visibility, public_name, public_description, double_opt_in, confirmation_email, unengaged, archived, archived_at), subscribers_count, usage, created_at e updated_at. Vedi Recupera una lista. Negli elenchi gli oggetti email non includono source.

total_recordsinteger

Il numero di liste che corrispondono alla ricerca, ai filtri e ad archived.

next_page_urlstring | null

Il percorso della pagina successiva, oppure null. Vedi Paginazione.

previous_page_urlstring | null

Il percorso della pagina precedente, oppure null.

GET/audiences

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const audiences = await emailit.audiences.list();

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

audiences = client.audiences.list()

PHP

$emailit = Emailit::client('your_api_key');

$audiences = $emailit->audiences()->list();

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

audiences = client.audiences.list

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

audiences, err := client.Audiences.List(nil)

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

let audiences = emailit.audiences.list(None).await?;

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audiences = emailit.audiences().list();

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audiences = emailit.Audiences.List();

PHP

use Emailit\Laravel\Facades\Emailit;

$audiences = Emailit::audiences()->list();

Terminal

curl https://api.emailit.com/v2/audiences \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JSON

{
  "data": [
    {
      "object": "audience",
      "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "name": "Newsletter",
      "visibility": "public",
      "public_name": "Monthly newsletter",
      "public_description": "Product news and tips, once a month.",
      "double_opt_in": {
        "enabled": true,
        "redirect_url": null,
        "email": {
          "from": "News <news@example.com>",
          "reply_to": null,
          "subject": "Confirm your subscription to {{audience_name}}",
          "design": "default",
          "heading": "Please confirm your subscription",
          "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
          "button_label": "Confirm subscription",
          "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm."
        }
      },
      "confirmation_email": {
        "enabled": false,
        "email": {
          "from": "News <news@example.com>",
          "reply_to": null,
          "subject": "You're subscribed to {{audience_name}}",
          "design": "default",
          "heading": "You're subscribed",
          "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
          "button_label": "",
          "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
          "button_url": ""
        }
      },
      "unengaged": {
        "exclude": false,
        "days": 365
      },
      "archived": false,
      "archived_at": null,
      "subscribers_count": 1284,
      "usage": {
        "used": 1284,
        "limit": 50000,
        "plan": "pro"
      },
      "created_at": "2026-10-01T10:02:44.000000Z",
      "updated_at": "2026-10-01T10:02:44.000000Z"
    },
    {
      "object": "audience",
      "id": "aud_4KOlh9t2uw5od4qypqCtyrZyDq2",
      "name": "Customers",
      "visibility": "private",
      "public_name": null,
      "public_description": null,
      "double_opt_in": {
        "enabled": false,
        "redirect_url": null,
        "email": {
          "from": null,
          "reply_to": null,
          "subject": "Confirm your subscription to {{audience_name}}",
          "design": "default",
          "heading": "Please confirm your subscription",
          "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
          "button_label": "Confirm subscription",
          "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm."
        }
      },
      "confirmation_email": {
        "enabled": false,
        "email": {
          "from": null,
          "reply_to": null,
          "subject": "You're subscribed to {{audience_name}}",
          "design": "default",
          "heading": "You're subscribed",
          "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
          "button_label": "",
          "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
          "button_url": ""
        }
      },
      "unengaged": {
        "exclude": false,
        "days": 365
      },
      "archived": false,
      "archived_at": null,
      "subscribers_count": 312,
      "usage": {
        "used": 312,
        "limit": 50000,
        "plan": "pro"
      },
      "created_at": "2026-09-20T16:45:10.000000Z",
      "updated_at": "2026-09-20T16:45:10.000000Z"
    }
  ],
  "total_records": 2,
  "next_page_url": null,
  "previous_page_url": null
}

Unisci le liste

Copia in questa lista gli iscritti di altre liste.

POST/audiences/{id}/merge

Richiede una chiave API full. Le persone già presenti nella lista di destinazione mantengono lì il loro stato, quindi nessuno che si è disiscritto viene iscritto di nuovo. Una persona presente in più liste unite entra con Subscribed attivo se è iscritta ad almeno una di esse. Con delete_sources, le liste unite vengono poi eliminate e le campagne destinate a quelle liste che non hanno ancora finito l’invio (bozze, campagne programmate, in coda e in invio, e test A/B in attesa della variante vincente) vengono inviate alla lista di destinazione. Se una di queste campagne includeva una lista unita e ne escludeva un’altra, la lista di destinazione resta inclusa. I segmenti che hanno come origine una lista eliminata, o che hanno una regola su di essa, usano al suo posto la lista di destinazione, e lo stesso vale per i trigger, i passaggi, le condizioni e le condizioni di uscita delle automazioni che la indicano. Lo stesso vale per i moduli che vi aggiungono persone o la propongono come scelta, per i link di double opt-in non ancora confermati e per le esecuzioni delle automazioni in attesa di una condizione su quella lista. Ogni eliminazione genera audience.deleted.

L’unione non genera eventi subscriber.*, non avvia automazioni e non invia email di double opt-in o di conferma. Se i nuovi iscritti portassero la lista di destinazione oltre il limite di iscritti del piano, non viene unito nulla e la richiesta restituisce 422 con il tuo usage. Anche un input non valido, ad esempio unire una lista in sé stessa, restituisce 422. Vedi Unisci le liste.

Parametri di percorso

idstringobbligatorio

La lista in cui unire le altre, per ID o per nome.

Parametri del corpo

source_idsstring[]obbligatorio

Gli ID delle liste da unire, da 1 a 50. Non può includere la lista di destinazione.

delete_sourcesbooleanpredefinito: false

Elimina le liste unite dopo averne copiato gli iscritti.

Restituisce

objectstring

Sempre audience_merge.

audienceobject

La lista di destinazione: object, id, name e il suo nuovo subscribers_count.

addedinteger

Quante persone sono entrate nella lista di destinazione.

already_in_audienceinteger

Quante persone delle liste unite erano già nella lista di destinazione e hanno mantenuto il loro stato.

deleted_source_idsstring[]

Le liste eliminate, oppure un array vuoto.

POST/audiences/{id}/merge

JavaScript

const response = await fetch('https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/merge', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    source_ids: ['aud_4KOlh9t2uw5od4qypqCtyrZyDq2'],
    delete_sources: true
  })
});

const { added, already_in_audience } = await response.json();

Terminal

curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/merge \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source_ids": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"], "delete_sources": true}'

JSON

{
  "object": "audience_merge",
  "audience": {
    "object": "audience",
    "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
    "name": "Newsletter",
    "subscribers_count": 1503
  },
  "added": 219,
  "already_in_audience": 93,
  "deleted_source_ids": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

JSON

{
  "error": "One or more audiences were not found",
  "missing": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

JSON

{
  "message": "Validation failed.",
  "errors": {
    "source_ids": ["An audience cannot be merged into itself."]
  }
}

Aggiorna le liste in blocco

Archivia, toglie dall’archivio o elimina più liste in una volta.

POST/audiences/bulk

Richiede una chiave API full. Ogni ID deve appartenere al workspace, altrimenti non cambia nulla e la richiesta restituisce 404 con gli ID in missing. L’archiviazione e la rimozione dall’archivio generano audience.updated; l’eliminazione genera audience.deleted e rimuove gli iscritti delle liste, come Elimina una lista. Vedi Archivia una lista.

Parametri del corpo

actionstringobbligatorio

archive, unarchive o delete.

idsstring[]obbligatorio

Gli ID delle liste, da 1 a 100.

Restituisce

objectstring

Sempre audience_bulk.

actionstring

L’azione che hai inviato.

processedinteger

Quante liste sono state trovate.

changedinteger

Quante sono state effettivamente modificate. Archiviare una lista già archiviata non conta.

idsstring[]

Gli ID che hai inviato.

POST/audiences/bulk

JavaScript

const response = await fetch('https://api.emailit.com/v2/audiences/bulk', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: 'archive',
    ids: ['aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'aud_4KOlh9t2uw5od4qypqCtyrZyDq2']
  })
});

const { changed } = await response.json();

Terminal

curl -X POST https://api.emailit.com/v2/audiences/bulk \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action": "archive", "ids": ["aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]}'

JSON

{
  "object": "audience_bulk",
  "action": "archive",
  "processed": 2,
  "changed": 2,
  "ids": ["aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

JSON

{
  "error": "One or more audiences were not found",
  "missing": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

Elimina una lista

Elimina definitivamente una lista e ne rimuove tutti gli iscritti.

DELETE/audiences/{id}

Richiede una chiave API full. Le iscrizioni alla lista vengono eliminate insieme a essa, ma i contatti restano nel workspace e nelle loro altre liste. Il suo URL di iscrizione ospitato smette di funzionare. Genera un evento audience.deleted. Per le iscrizioni rimosse non viene inviato alcun evento subscriber.deleted.

Parametri di percorso

idstringobbligatorio

L’ID della lista o il suo nome.

Restituisce

objectstring

Sempre audience.

idstring

L’ID della lista eliminata.

namestring

Il nome della lista.

deletedboolean

Sempre true.

DELETE/audiences/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

await emailit.audiences.delete('aud_4KOlh9t2uw5od4qypqCtyrZyDq2');

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

client.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")

PHP

$emailit = Emailit::client('your_api_key');

$emailit->audiences()->delete('aud_4KOlh9t2uw5od4qypqCtyrZyDq2');

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

client.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

err := client.Audiences.Delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")

Rust

use emailit::Emailit;

let emailit = Emailit::new("your_api_key");

emailit.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2").await?;

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

emailit.audiences().delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2");

using Emailit;

var emailit = new EmailitClient("your_api_key");

emailit.Audiences.Delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2");

PHP

use Emailit\Laravel\Facades\Emailit;

Emailit::audiences()->delete('aud_4KOlh9t2uw5od4qypqCtyrZyDq2');

Terminal

curl -X DELETE https://api.emailit.com/v2/audiences/aud_4KOlh9t2uw5od4qypqCtyrZyDq2 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JSON

{
  "object": "audience",
  "id": "aud_4KOlh9t2uw5od4qypqCtyrZyDq2",
  "name": "Customers",
  "deleted": true
}

JSON

{
  "error": "Audience not found"
}