# Listes de contacts API

> Gérez les listes d’abonnés utilisées par les campagnes et les formulaires d’inscription.

URL de base : `https://api.emailit.com/v2`. Authentifiez-vous avec `Authorization: Bearer <API key>`.

## Créer une liste de contacts — POST /audiences

> Créez une liste de contacts : une liste d’abonnés à qui vous pouvez envoyer des campagnes et pour laquelle vous recueillez des inscriptions avec des formulaires ou un lien d’inscription hébergé.

# Créer une liste de contacts

Crée une liste de contacts vide.

`POST /audiences`

Nécessite une clé API `full`. Ajoutez des personnes avec [Ajouter un abonné](/fr/docs/api-reference/audiences/subscribers/add/), ou en transmettant l’ID de la liste dans `audiences` lorsque vous [créez un contact](/fr/docs/api-reference/contacts/create/). Déclenche l’événement `audience.created`. Consultez [Listes de contacts](/fr/docs/audiences/).

## Paramètres du corps

- `name` (string, obligatoire): Le nom de la liste, par exemple `Newsletter`. Doit être unique dans l’espace de travail.

## Réponse

Renvoie `201` avec la nouvelle liste :

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

- `id` (string): L’ID de la liste.

- `name` (string): Le nom de la liste.

- `token` (string): Le jeton public de l’[URL d’inscription hébergée](/fr/docs/audiences/subscribe-url/) de la liste.

- `created_at` (string): Date de création de la liste.

- `updated_at` (string): Date de la dernière modification de la liste.

**Requête** `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"
  }
}
```

---
Source: https://emailit.com/fr/docs/api-reference/audiences/create/

## Récupérer une liste de contacts — GET /audiences/{id}

> Récupérez une liste de contacts par son ID ou son nom, avec son nombre d’abonnés, la limite d’abonnés de votre forfait et le jeton de son URL d’inscription hébergée.

# Récupérer une liste de contacts

Récupère une liste de contacts avec son nombre d’abonnés et son jeton public.

`GET /audiences/{id}`

Nécessite une clé API `full`.

## Paramètres de chemin

- `id` (string, obligatoire): L’ID de la liste (`aud_…`) ou son nom exact, encodé pour l’URL.

## Réponse

Renvoie l’objet liste.

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

- `id` (string): L’ID de la liste.

- `name` (string): Le nom de la liste.

- `token` (string): Le jeton public de l’[URL d’inscription hébergée](/fr/docs/audiences/subscribe-url/) de la liste. Considérez-le comme public : toute personne qui le possède peut s’inscrire à la liste.

- `subscribers_count` (integer): Nombre de contacts dans la liste, désinscrits compris.

- `usage` (object): `used` (le même nombre), `limit` (le nombre maximal d’abonnés qu’une liste peut compter sur votre forfait, ou `null` s’il n’y a pas de limite) et `plan`. Consultez [Limites](/fr/docs/limits/).

- `created_at` (string): Date de création de la liste.

- `updated_at` (string): Date de la dernière modification de la liste.

**Requête** `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"
}
```

---
Source: https://emailit.com/fr/docs/api-reference/audiences/get/

## Mettre à jour une liste de contacts — POST /audiences/{id}

> Renommez une liste de contacts. Son ID, son jeton public et ses abonnés restent les mêmes.

# Mettre à jour une liste de contacts

Renomme une liste de contacts.

`POST /audiences/{id}`

Nécessite une clé API `full`. L’ID, le jeton et les abonnés ne changent pas. Déclenche l’événement `audience.updated`.

## Paramètres de chemin

- `id` (string, obligatoire): L’ID de la liste ou son nom actuel.

## Paramètres du corps

- `name` (string, obligatoire): Le nouveau nom. Doit être unique dans l’espace de travail.

## Réponse

Renvoie la liste avec `object`, `id`, `name`, `token`, `subscribers_count`, `created_at` et `updated_at`. Dans cette réponse, `subscribers_count` vaut toujours `0` ; utilisez [Récupérer une liste de contacts](/fr/docs/api-reference/audiences/get/) pour obtenir le nombre réel.

**Requête** `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"
}
```

---
Source: https://emailit.com/fr/docs/api-reference/audiences/update/

## Lister les listes de contacts — GET /audiences

> Listez les listes de contacts d’un espace de travail avec leur nombre d’abonnés et les limites du forfait, de la plus récente à la plus ancienne, avec recherche, filtres et tri.

# Lister les listes de contacts

Renvoie une page de listes de contacts, de la plus récente à la plus ancienne.

`GET /audiences`

Nécessite une clé API `full`. Les éléments de la liste n’incluent pas le `token` de la liste de contacts ; utilisez [Récupérer une liste de contacts](/fr/docs/api-reference/audiences/get/) pour l’obtenir.

## Paramètres de requête

- `page` (integer): La page à renvoyer.

- `limit` (integer): Nombre de listes par page, de 1 à 100.

- `search` (string): Recherche insensible à la casse sur le nom de la liste.

- `match` (string): `all` ou `or`. Mode de combinaison des filtres ci-dessous.

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

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

## Filtres

Ajoutez des filtres sous la forme `key.condition=value`, par exemple `name.contains=news`. Consultez [Filtrage et tri](/fr/docs/api-reference/filtering/).

| Clé | Type |
| --- | --- |
| `name` | chaîne |
| `created_at` | date |

## Réponse

- `data` (object[]): Les listes de cette page, chacune avec `object`, `id`, `name`, `subscribers_count`, `usage`, `created_at` et `updated_at`. Consultez [Récupérer une liste de contacts](/fr/docs/api-reference/audiences/get/).

- `total_records` (integer): Le nombre de listes dans l’espace de travail.

- `next_page_url` (string | null): Chemin de la page suivante, ou `null`. Consultez [Pagination](/fr/docs/api-reference/pagination/).

- `previous_page_url` (string | null): Chemin de la page précédente, ou `null`.

**Requête** `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
}
```

---
Source: https://emailit.com/fr/docs/api-reference/audiences/list/

## Supprimer une liste de contacts — DELETE /audiences/{id}

> Supprimez définitivement une liste de contacts et toutes ses inscriptions d’abonnés. Les contacts eux-mêmes restent dans votre espace de travail.

# Supprimer une liste de contacts

Supprime définitivement une liste de contacts et en retire tout le monde.

`DELETE /audiences/{id}`

Nécessite une clé API `full`. Les inscriptions d’abonnés de la liste sont supprimées avec elle, mais les [contacts](/fr/docs/api-reference/contacts/) restent dans votre espace de travail et dans leurs autres listes. Son URL d’inscription hébergée cesse de fonctionner. Déclenche l’événement `audience.deleted`. Aucun événement `subscriber.deleted` n’est envoyé pour les inscriptions supprimées.

## Paramètres de chemin

- `id` (string, obligatoire): L’ID de la liste ou son nom.

## Réponse

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

- `id` (string): L’ID de la liste supprimée.

- `name` (string): Le nom de la liste.

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

**Requête** `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"
}
```

---
Source: https://emailit.com/fr/docs/api-reference/audiences/delete/