# Listas de contatos API

> Gerencie as listas de inscritos usadas por campanhas e formulários de inscrição.

URL base: `https://api.emailit.com/v2`. Autentique-se com `Authorization: Bearer <API key>`.

## Criar uma lista de contatos — POST /audiences

> Crie uma lista de contatos, uma lista de inscritos para a qual você pode enviar campanhas e coletar inscrições com formulários ou um link de inscrição hospedado.

# Criar uma lista de contatos

Cria uma lista de contatos vazia.

`POST /audiences`

Requer uma chave de API com escopo `full`. Adicione pessoas com [Adicionar um inscrito](/pt/docs/api-reference/audiences/subscribers/add/) ou passando o ID da lista em `audiences` ao [criar um contato](/pt/docs/api-reference/contacts/create/). Dispara um evento `audience.created`. Consulte [Listas de contatos](/pt/docs/audiences/).

## Parâmetros do corpo

- `name` (string, obrigatório): O nome da lista, como `Newsletter`. Deve ser único no workspace.

## Retorno

Retorna `201` com a nova lista de contatos:

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

- `id` (string): O ID da lista de contatos.

- `name` (string): O nome da lista de contatos.

- `token` (string): O token público da [URL de inscrição hospedada](/pt/docs/audiences/subscribe-url/) da lista.

- `created_at` (string): Quando a lista foi criada.

- `updated_at` (string): Quando a lista foi alterada pela última vez.

**Requisição** `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/pt/docs/api-reference/audiences/create/

## Obter uma lista de contatos — GET /audiences/{id}

> Obtenha uma lista de contatos pelo ID ou pelo nome, com a contagem de inscritos, o limite de inscritos do seu plano e o token da URL de inscrição hospedada.

# Obter uma lista de contatos

Obtém uma lista de contatos com a contagem de inscritos e o token público.

`GET /audiences/{id}`

Requer uma chave de API com escopo `full`.

## Parâmetros de caminho

- `id` (string, obrigatório): O ID da lista de contatos (`aud_…`) ou o nome exato dela, codificado para URL.

## Retorno

Retorna o objeto da lista de contatos.

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

- `id` (string): O ID da lista de contatos.

- `name` (string): O nome da lista de contatos.

- `token` (string): O token público da [URL de inscrição hospedada](/pt/docs/audiences/subscribe-url/) da lista. Trate-o como público: qualquer pessoa que o tenha pode se inscrever na lista.

- `subscribers_count` (integer): Quantos contatos estão na lista, incluindo os descadastrados.

- `usage` (object): `used` (a mesma contagem), `limit` (o número máximo de inscritos que uma lista pode ter no seu plano, ou `null` se não houver limite) e `plan`. Consulte [Limites](/pt/docs/limits/).

- `created_at` (string): Quando a lista foi criada.

- `updated_at` (string): Quando a lista foi alterada pela última vez.

**Requisição** `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/pt/docs/api-reference/audiences/get/

## Atualizar uma lista de contatos — POST /audiences/{id}

> Renomeie uma lista de contatos. O ID, o token público e os inscritos dela continuam os mesmos.

# Atualizar uma lista de contatos

Renomeia uma lista de contatos.

`POST /audiences/{id}`

Requer uma chave de API com escopo `full`. O ID, o token e os inscritos não mudam. Dispara um evento `audience.updated`.

## Parâmetros de caminho

- `id` (string, obrigatório): O ID da lista de contatos ou o nome atual dela.

## Parâmetros do corpo

- `name` (string, obrigatório): O novo nome. Deve ser único no workspace.

## Retorno

Retorna a lista de contatos com `object`, `id`, `name`, `token`, `subscribers_count`, `created_at` e `updated_at`. Nesta resposta, `subscribers_count` é sempre `0`; use [Obter uma lista de contatos](/pt/docs/api-reference/audiences/get/) para a contagem real.

**Requisição** `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/pt/docs/api-reference/audiences/update/

## Listar listas de contatos — GET /audiences

> Liste as listas de contatos de um workspace com as contagens de inscritos e os limites do plano, das mais recentes para as mais antigas, com busca, filtros e ordenação.

# Listar listas de contatos

Retorna uma página de listas de contatos, das mais recentes para as mais antigas.

`GET /audiences`

Requer uma chave de API com escopo `full`. Os itens da listagem não incluem o `token` da lista; use [Obter uma lista de contatos](/pt/docs/api-reference/audiences/get/) para obtê-lo.

## Parâmetros de consulta

- `page` (integer): A página a retornar.

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

- `search` (string): Busca sem diferenciar maiúsculas de minúsculas no nome da lista.

- `match` (string): `all` ou `or`. Como os filtros abaixo se combinam.

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

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

## Filtros

Adicione filtros no formato `key.condition=value`, por exemplo `name.contains=news`. Consulte [Filtragem](/pt/docs/api-reference/filtering/).

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

## Retorno

- `data` (object[]): As listas de contatos desta página, cada uma com `object`, `id`, `name`, `subscribers_count`, `usage`, `created_at` e `updated_at`. Consulte [Obter uma lista de contatos](/pt/docs/api-reference/audiences/get/).

- `total_records` (integer): O número de listas de contatos no workspace.

- `next_page_url` (string | null): Caminho da próxima página, ou `null`. Consulte [Paginação](/pt/docs/api-reference/pagination/).

- `previous_page_url` (string | null): Caminho da página anterior, ou `null`.

**Requisição** `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/pt/docs/api-reference/audiences/list/

## Excluir uma lista de contatos — DELETE /audiences/{id}

> Exclua permanentemente uma lista de contatos e todas as participações de inscritos nela. Os contatos em si continuam no seu workspace.

# Excluir uma lista de contatos

Exclui permanentemente uma lista de contatos e remove todas as pessoas dela.

`DELETE /audiences/{id}`

Requer uma chave de API com escopo `full`. As participações de inscritos na lista são excluídas com ela, mas os [contatos](/pt/docs/api-reference/contacts/) continuam no seu workspace e nas outras listas deles. A URL de inscrição hospedada da lista para de funcionar. Dispara um evento `audience.deleted`. Nenhum evento `subscriber.deleted` é enviado para as participações removidas.

## Parâmetros de caminho

- `id` (string, obrigatório): O ID da lista de contatos ou o nome dela.

## Retorno

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

- `id` (string): O ID da lista de contatos excluída.

- `name` (string): O nome da lista de contatos.

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

**Requisição** `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/pt/docs/api-reference/audiences/delete/