# Listas de contactos API

> Gestiona las listas de suscriptores que usan las campañas y los formularios de suscripción.

URL base: `https://api.emailit.com/v2`. Autentícate con `Authorization: Bearer <API key>`.

## Crear una lista de contactos — POST /audiences

> Crea una lista de contactos: una lista de suscriptores a la que puedes enviar campañas y en la que puedes recoger altas con formularios o con un enlace de suscripción alojado.

# Crear una lista de contactos

Crea una lista de contactos vacía.

`POST /audiences`

Requiere una clave de API `full`. Añade personas con [Añadir un suscriptor](/es/docs/api-reference/audiences/subscribers/add/) o pasando el ID de la lista en `audiences` al [crear un contacto](/es/docs/api-reference/contacts/create/). Dispara un evento `audience.created`. Consulta [Listas de contactos](/es/docs/audiences/).

## Parámetros del cuerpo

- `name` (string, obligatorio): El nombre de la lista, como `Newsletter`. Debe ser único en el espacio de trabajo.

## Devuelve

Devuelve `201` con la nueva lista:

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

- `id` (string): El ID de la lista.

- `name` (string): El nombre de la lista.

- `token` (string): El token público de la [URL de suscripción alojada](/es/docs/audiences/subscribe-url/) de la lista.

- `created_at` (string): Cuándo se creó la lista.

- `updated_at` (string): Cuándo se modificó la lista por última vez.

**Petición** `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"
  }
}
```

---
Fuente: https://emailit.com/es/docs/api-reference/audiences/create/

## Obtener una lista de contactos — GET /audiences/{id}

> Obtén una lista de contactos por su ID o su nombre, con su número de suscriptores, el límite de suscriptores de tu plan y el token de su URL de suscripción alojada.

# Obtener una lista de contactos

Obtiene una lista de contactos con su número de suscriptores y su token público.

`GET /audiences/{id}`

Requiere una clave de API `full`.

## Parámetros de ruta

- `id` (string, obligatorio): El ID de la lista (`aud_…`) o su nombre exacto, codificado para URL.

## Devuelve

Devuelve el objeto de lista de contactos.

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

- `id` (string): El ID de la lista.

- `name` (string): El nombre de la lista.

- `token` (string): El token público de la [URL de suscripción alojada](/es/docs/audiences/subscribe-url/) de la lista. Trátalo como público: cualquiera que lo tenga puede suscribirse a la lista.

- `subscribers_count` (integer): Cuántos contactos hay en la lista, incluidos los dados de baja.

- `usage` (object): `used` (el mismo número), `limit` (el número máximo de suscriptores que puede tener una lista en tu plan, o `null` si no hay límite) y `plan`. Consulta [Límites](/es/docs/limits/).

- `created_at` (string): Cuándo se creó la lista.

- `updated_at` (string): Cuándo se modificó la lista por última vez.

**Petición** `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"
}
```

---
Fuente: https://emailit.com/es/docs/api-reference/audiences/get/

## Actualizar una lista de contactos — POST /audiences/{id}

> Cambia el nombre de una lista de contactos. Su ID, su token público y sus suscriptores no cambian.

# Actualizar una lista de contactos

Cambia el nombre de una lista de contactos.

`POST /audiences/{id}`

Requiere una clave de API `full`. El ID, el token y los suscriptores no cambian. Dispara un evento `audience.updated`.

## Parámetros de ruta

- `id` (string, obligatorio): El ID de la lista o su nombre actual.

## Parámetros del cuerpo

- `name` (string, obligatorio): El nuevo nombre. Debe ser único en el espacio de trabajo.

## Devuelve

Devuelve la lista con `object`, `id`, `name`, `token`, `subscribers_count`, `created_at` y `updated_at`. En esta respuesta, `subscribers_count` siempre es `0`; para el número real, usa [Obtener una lista de contactos](/es/docs/api-reference/audiences/get/).

**Petición** `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"
}
```

---
Fuente: https://emailit.com/es/docs/api-reference/audiences/update/

## Listar listas de contactos — GET /audiences

> Obtén las listas de contactos de un espacio de trabajo con su número de suscriptores y los límites del plan, de la más reciente a la más antigua, con búsqueda, filtros y ordenación.

# Listar listas de contactos

Devuelve una página de listas de contactos, de la más reciente a la más antigua.

`GET /audiences`

Requiere una clave de API `full`. Los elementos del listado no incluyen el `token` de la lista; para obtenerlo, usa [Obtener una lista de contactos](/es/docs/api-reference/audiences/get/).

## Parámetros de consulta

- `page` (integer): La página que se devuelve.

- `limit` (integer): Listas por página, de 1 a 100.

- `search` (string): Búsqueda en el nombre de la lista, sin distinguir mayúsculas y minúsculas.

- `match` (string): `all` u `or`. Cómo se combinan los filtros de abajo.

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

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

## Filtros

Añade filtros con el formato `key.condition=value`, por ejemplo `name.contains=news`. Consulta [Filtrado](/es/docs/api-reference/filtering/).

| Clave | Tipo |
| --- | --- |
| `name` | cadena |
| `created_at` | fecha |

## Devuelve

- `data` (object[]): Las listas de esta página, cada una con `object`, `id`, `name`, `subscribers_count`, `usage`, `created_at` y `updated_at`. Consulta [Obtener una lista de contactos](/es/docs/api-reference/audiences/get/).

- `total_records` (integer): El número de listas del espacio de trabajo.

- `next_page_url` (string | null): La ruta de la página siguiente, o `null`. Consulta [Paginación](/es/docs/api-reference/pagination/).

- `previous_page_url` (string | null): La ruta de la página anterior, o `null`.

**Petición** `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
}
```

---
Fuente: https://emailit.com/es/docs/api-reference/audiences/list/

## Eliminar una lista de contactos — DELETE /audiences/{id}

> Elimina de forma permanente una lista de contactos y todas las pertenencias de sus suscriptores. Los contactos siguen en tu espacio de trabajo.

# Eliminar una lista de contactos

Elimina de forma permanente una lista de contactos y quita de ella a todos sus suscriptores.

`DELETE /audiences/{id}`

Requiere una clave de API `full`. Las pertenencias de los suscriptores a la lista se eliminan con ella, pero los [contactos](/es/docs/api-reference/contacts/) siguen en tu espacio de trabajo y en sus otras listas. Su URL de suscripción alojada deja de funcionar. Dispara un evento `audience.deleted`. No se envían eventos `subscriber.deleted` por las pertenencias eliminadas.

## Parámetros de ruta

- `id` (string, obligatorio): El ID o el nombre de la lista.

## Devuelve

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

- `id` (string): El ID de la lista eliminada.

- `name` (string): El nombre de la lista.

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

**Petición** `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"
}
```

---
Fuente: https://emailit.com/es/docs/api-reference/audiences/delete/