# Liste API

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

URL di base: `https://api.emailit.com/v2`. Autenticati con `Authorization: Bearer <API key>`.

## Crea una lista — POST /audiences

> Crea una lista, cioè un elenco di iscritti a cui puoi inviare campagne e per cui puoi raccogliere iscrizioni con moduli o con un link di iscrizione ospitato.

# Crea una lista

Crea una lista vuota.

`POST /audiences`

Richiede una chiave API `full`. Aggiungi persone con [Aggiungi un iscritto](/it/docs/api-reference/audiences/subscribers/add/), oppure passando l’ID della lista in `audiences` quando [crei un contatto](/it/docs/api-reference/contacts/create/). Genera un evento `audience.created`. Vedi [Liste](/it/docs/audiences/).

## Parametri del corpo

- `name` (string, obbligatorio): Il nome della lista, ad esempio `Newsletter`. Deve essere univoco nel workspace.

## Restituisce

Restituisce `201` con la nuova lista:

- `object` (string): Sempre `audience`.

- `id` (string): L’ID della lista.

- `name` (string): Il nome della lista.

- `token` (string): Il token pubblico per l’[URL di iscrizione ospitato](/it/docs/audiences/subscribe-url/) della lista.

- `created_at` (string): Quando è stata creata la lista.

- `updated_at` (string): Quando la lista è stata modificata l’ultima volta.

**Richiesta** `POST /audiences`

**Node.js**

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

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

**Python**

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

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

**PHP**

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

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

**Ruby**

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

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

**Go**

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

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

**Rust**

```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**

```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()
);
```

**.NET**

```csharp
using Emailit;

var emailit = new EmailitClient("your_api_key");

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

**Laravel**

```php
use Emailit\Laravel\Facades\Emailit;

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

**cURL**

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

**201**

```json
{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "created_at": "2026-10-01T10:02:44.613207Z",
  "updated_at": "2026-10-01T10:02:44.613207Z"
}
```

**409**

```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"
  }
}
```

---
Fonte: https://emailit.com/it/docs/api-reference/audiences/create/

## Recupera una lista — GET /audiences/{id}

> Recupera una lista per ID o per nome, con il numero di iscritti, il limite di iscritti del piano e il token del suo URL di iscrizione ospitato.

# Recupera una lista

Recupera una lista con il numero di iscritti e il token pubblico.

`GET /audiences/{id}`

Richiede una chiave API `full`.

## Parametri di percorso

- `id` (string, obbligatorio): L’ID della lista (`aud_…`) o il suo nome esatto, codificato per l’URL.

## Restituisce

Restituisce l’oggetto lista.

- `object` (string): Sempre `audience`.

- `id` (string): L’ID della lista.

- `name` (string): Il nome della lista.

- `token` (string): Il token pubblico per l’[URL di iscrizione ospitato](/it/docs/audiences/subscribe-url/) della lista. Consideralo pubblico: chiunque lo abbia può iscriversi alla lista.

- `subscribers_count` (integer): Quanti contatti ci sono nella lista, compresi quelli disiscritti.

- `usage` (object): `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](/it/docs/limits/).

- `created_at` (string): Quando è stata creata la lista.

- `updated_at` (string): Quando la lista è stata modificata l’ultima volta.

**Richiesta** `GET /audiences/{id}`

**Node.js**

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

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

**Python**

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

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

**PHP**

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

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

**Ruby**

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

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

**Go**

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

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

**Rust**

```rust
use emailit::Emailit;

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

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

**Java**

```java
import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

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

**.NET**

```csharp
using Emailit;

var emailit = new EmailitClient("your_api_key");

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

**Laravel**

```php
use Emailit\Laravel\Facades\Emailit;

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

**cURL**

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

**200**

```json
{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "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"
}
```

**404**

```json
{
  "error": "Audience not found"
}
```

---
Fonte: https://emailit.com/it/docs/api-reference/audiences/get/

## Aggiorna una lista — POST /audiences/{id}

> Rinomina una lista. L’ID, il token pubblico e gli iscritti restano invariati.

# Aggiorna una lista

Rinomina una lista.

`POST /audiences/{id}`

Richiede una chiave API `full`. L’ID, il token e gli iscritti non cambiano. Genera un evento `audience.updated`.

## Parametri di percorso

- `id` (string, obbligatorio): L’ID della lista o il suo nome attuale.

## Parametri del corpo

- `name` (string, obbligatorio): Il nuovo nome. Deve essere univoco nel workspace.

## Restituisce

Restituisce la lista con `object`, `id`, `name`, `token`, `subscribers_count`, `created_at` e `updated_at`. In questa risposta `subscribers_count` è sempre `0`; per il numero reale usa [Recupera una lista](/it/docs/api-reference/audiences/get/).

**Richiesta** `POST /audiences/{id}`

**Node.js**

```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**

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

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

**PHP**

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

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

**Ruby**

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

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

**Go**

```go
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**

```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**

```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()
);
```

**.NET**

```csharp
using Emailit;

var emailit = new EmailitClient("your_api_key");

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

**Laravel**

```php
use Emailit\Laravel\Facades\Emailit;

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

**cURL**

```bash
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"}'
```

**200**

```json
{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Weekly newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "subscribers_count": 0,
  "created_at": "2026-10-01T10:02:44.000000Z",
  "updated_at": "2026-10-01T14:31:09.000000Z"
}
```

**400**

```json
{
  "error": "No valid fields provided for update. Provide at least one of: name"
}
```

**404**

```json
{
  "error": "Audience not found"
}
```

**409**

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

---
Fonte: https://emailit.com/it/docs/api-reference/audiences/update/

## Elenca le liste — GET /audiences

> Elenca le liste di un workspace con il numero di iscritti e i limiti del piano, a partire dalla più recente, con ricerca, filtri e ordinamento.

# Elenca le liste

Restituisce una pagina di liste, a partire dalla più recente.

`GET /audiences`

Richiede una chiave API `full`. Gli elementi dell’elenco non includono il `token` della lista; per ottenerlo usa [Recupera una lista](/it/docs/api-reference/audiences/get/).

## Parametri di query

- `page` (integer): La pagina da restituire.

- `limit` (integer): Liste per pagina, da 1 a 100.

- `search` (string): Corrispondenza sul nome della lista, senza distinzione tra maiuscole e minuscole.

- `match` (string): `all` o `or`. Come si combinano i filtri qui sotto.

- `order` (string): `name` o `created_at`.

- `direction` (string): `asc` o `desc`.

## Filtri

Aggiungi i filtri nella forma `key.condition=value`, ad esempio `name.contains=news`. Vedi [Filtri e ordinamento](/it/docs/api-reference/filtering/).

| Chiave | Tipo |
| --- | --- |
| `name` | string |
| `created_at` | date |

## Restituisce

- `data` (object[]): Le liste di questa pagina, ciascuna con `object`, `id`, `name`, `subscribers_count`, `usage`, `created_at` e `updated_at`. Vedi [Recupera una lista](/it/docs/api-reference/audiences/get/).

- `total_records` (integer): Il numero di liste nel workspace.

- `next_page_url` (string | null): Il percorso della pagina successiva, oppure `null`. Vedi [Paginazione](/it/docs/api-reference/pagination/).

- `previous_page_url` (string | null): Il percorso della pagina precedente, oppure `null`.

**Richiesta** `GET /audiences`

**Node.js**

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

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

**Python**

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

audiences = client.audiences.list()
```

**PHP**

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

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

**Ruby**

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

audiences = client.audiences.list
```

**Go**

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

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

**Rust**

```rust
use emailit::Emailit;

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

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

**Java**

```java
import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

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

**.NET**

```csharp
using Emailit;

var emailit = new EmailitClient("your_api_key");

var audiences = emailit.Audiences.List();
```

**Laravel**

```php
use Emailit\Laravel\Facades\Emailit;

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

**cURL**

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

**200**

```json
{
  "data": [
    {
      "object": "audience",
      "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "name": "Newsletter",
      "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",
      "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
}
```

---
Fonte: https://emailit.com/it/docs/api-reference/audiences/list/

## Elimina una lista — DELETE /audiences/{id}

> Elimina definitivamente una lista e tutte le iscrizioni a essa. I contatti restano nel workspace.

# 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](/it/docs/api-reference/contacts/) 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

- `id` (string, obbligatorio): L’ID della lista o il suo nome.

## Restituisce

- `object` (string): Sempre `audience`.

- `id` (string): L’ID della lista eliminata.

- `name` (string): Il nome della lista.

- `deleted` (boolean): Sempre `true`.

**Richiesta** `DELETE /audiences/{id}`

**Node.js**

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

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

**Python**

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

client.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")
```

**PHP**

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

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

**Ruby**

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

client.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")
```

**Go**

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

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

**Rust**

```rust
use emailit::Emailit;

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

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

**Java**

```java
import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

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

**.NET**

```csharp
using Emailit;

var emailit = new EmailitClient("your_api_key");

emailit.Audiences.Delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2");
```

**Laravel**

```php
use Emailit\Laravel\Facades\Emailit;

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

**cURL**

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

**200**

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

**404**

```json
{
  "error": "Audience not found"
}
```

---
Fonte: https://emailit.com/it/docs/api-reference/audiences/delete/
