# Seznamy kontaktů API

> Spravujte seznamy odběratelů pro kampaně a přihlašovací formuláře.

Základní URL: `https://api.emailit.com/v2`. Autentizujte se hlavičkou `Authorization: Bearer <API key>`.

## Vytvoření seznamu kontaktů — POST /audiences

> Vytvoří seznam kontaktů, tedy seznam odběratelů, kterým můžete posílat kampaně a do kterého můžete sbírat přihlášky přes formuláře nebo hostovaný odkaz pro přihlášení.

# Vytvoření seznamu kontaktů

Vytvoří prázdný seznam kontaktů.

`POST /audiences`

Vyžaduje API klíč s oprávněním `full`. Lidi přidáte přes [Přidání odběratele](/cs/docs/api-reference/audiences/subscribers/add/), nebo tak, že při [vytvoření kontaktu](/cs/docs/api-reference/contacts/create/) předáte ID seznamu v poli `audiences`. Vyvolá událost `audience.created`. Viz [Seznamy kontaktů](/cs/docs/audiences/).

## Parametry v těle požadavku

- `name` (string, povinné): Název seznamu, například `Newsletter`. Musí být ve workspace jedinečný.

## Odpověď

Vrací `201` s novým seznamem kontaktů:

- `object` (string): Vždy `audience`.

- `id` (string): ID seznamu kontaktů.

- `name` (string): Název seznamu.

- `token` (string): Veřejný token pro [hostovanou URL pro přihlášení](/cs/docs/audiences/subscribe-url/) k seznamu.

- `created_at` (string): Kdy byl seznam vytvořen.

- `updated_at` (string): Kdy se seznam naposledy změnil.

**Požadavek** `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"
  }
}
```

---
Zdroj: https://emailit.com/cs/docs/api-reference/audiences/create/

## Načtení seznamu kontaktů — GET /audiences/{id}

> Načte seznam kontaktů podle ID nebo názvu s počtem odběratelů, limitem odběratelů vašeho tarifu a tokenem pro hostovanou URL pro přihlášení.

# Načtení seznamu kontaktů

Načte seznam kontaktů s počtem odběratelů a veřejným tokenem.

`GET /audiences/{id}`

Vyžaduje API klíč s oprávněním `full`.

## Parametry v cestě

- `id` (string, povinné): ID seznamu kontaktů (`aud_…`), nebo jeho přesný název zakódovaný do URL.

## Odpověď

Vrací objekt seznamu kontaktů.

- `object` (string): Vždy `audience`.

- `id` (string): ID seznamu kontaktů.

- `name` (string): Název seznamu.

- `token` (string): Veřejný token pro [hostovanou URL pro přihlášení](/cs/docs/audiences/subscribe-url/) k seznamu. Považujte ho za veřejný: kdokoli, kdo ho má, se může k seznamu přihlásit.

- `subscribers_count` (integer): Kolik kontaktů je v seznamu, včetně odhlášených.

- `usage` (object): `used` (stejný počet), `limit` (nejvyšší počet odběratelů, který může seznam ve vašem tarifu mít, nebo `null`, pokud limit není) a `plan`. Viz [Limity](/cs/docs/limits/).

- `created_at` (string): Kdy byl seznam vytvořen.

- `updated_at` (string): Kdy se seznam naposledy změnil.

**Požadavek** `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"
}
```

---
Zdroj: https://emailit.com/cs/docs/api-reference/audiences/get/

## Úprava seznamu kontaktů — POST /audiences/{id}

> Přejmenujte seznam kontaktů. Jeho ID, veřejný token ani odběratelé se nezmění.

# Úprava seznamu kontaktů

Přejmenuje seznam kontaktů.

`POST /audiences/{id}`

Vyžaduje API klíč s oprávněním `full`. ID, token ani odběratelé se nezmění. Vyvolá událost `audience.updated`.

## Parametry v cestě

- `id` (string, povinné): ID seznamu kontaktů, nebo jeho aktuální název.

## Parametry v těle požadavku

- `name` (string, povinné): Nový název. Musí být ve workspace jedinečný.

## Odpověď

Vrací seznam kontaktů s poli `object`, `id`, `name`, `token`, `subscribers_count`, `created_at` a `updated_at`. V této odpovědi je `subscribers_count` vždy `0`; skutečný počet zjistíte endpointem [Načtení seznamu kontaktů](/cs/docs/api-reference/audiences/get/).

**Požadavek** `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"
}
```

---
Zdroj: https://emailit.com/cs/docs/api-reference/audiences/update/

## Výpis seznamů kontaktů — GET /audiences

> Vypíše seznamy kontaktů workspace s počty odběratelů a limity tarifu, od nejnovějších, s vyhledáváním, filtry a řazením.

# Výpis seznamů kontaktů

Vrátí stránku seznamů kontaktů, od nejnovějších.

`GET /audiences`

Vyžaduje API klíč s oprávněním `full`. Položky výpisu neobsahují `token` seznamu; ten získáte přes [Načtení seznamu kontaktů](/cs/docs/api-reference/audiences/get/).

## Parametry dotazu

- `page` (integer): Stránka, kterou chcete načíst.

- `limit` (integer): Počet seznamů na stránce, od 1 do 100.

- `search` (string): Hledá v názvu seznamu bez ohledu na velikost písmen.

- `match` (string): `all`, nebo `or`. Jak se kombinují filtry níže.

- `order` (string): `name`, nebo `created_at`.

- `direction` (string): `asc`, nebo `desc`.

## Filtry

Filtry přidávejte ve tvaru `key.condition=value`, například `name.contains=news`. Viz [Filtrování](/cs/docs/api-reference/filtering/).

| Klíč | Typ |
| --- | --- |
| `name` | string |
| `created_at` | date |

## Odpověď

- `data` (object[]): Seznamy kontaktů na této stránce, každý s `object`, `id`, `name`, `subscribers_count`, `usage`, `created_at` a `updated_at`. Viz [Načtení seznamu kontaktů](/cs/docs/api-reference/audiences/get/).

- `total_records` (integer): Počet seznamů kontaktů ve workspace.

- `next_page_url` (string | null): Cesta k další stránce, nebo `null`. Viz [Stránkování](/cs/docs/api-reference/pagination/).

- `previous_page_url` (string | null): Cesta k předchozí stránce, nebo `null`.

**Požadavek** `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
}
```

---
Zdroj: https://emailit.com/cs/docs/api-reference/audiences/list/

## Smazání seznamu kontaktů — DELETE /audiences/{id}

> Natrvalo smaže seznam kontaktů a všechna členství odběratelů v něm. Samotné kontakty ve vašem workspace zůstanou.

# Smazání seznamu kontaktů

Natrvalo smaže seznam kontaktů a všechny z něj odebere.

`DELETE /audiences/{id}`

Vyžaduje API klíč s oprávněním `full`. Spolu se seznamem se smažou i členství jeho odběratelů, ale [kontakty](/cs/docs/api-reference/contacts/) zůstanou ve vašem workspace i ve svých ostatních seznamech. Hostovaná URL pro přihlášení k seznamu přestane fungovat. Vyvolá událost `audience.deleted`. Za odebraná členství se neposílají žádné události `subscriber.deleted`.

## Parametry v cestě

- `id` (string, povinné): ID seznamu kontaktů, nebo jeho název.

## Odpověď

- `object` (string): Vždy `audience`.

- `id` (string): ID smazaného seznamu kontaktů.

- `name` (string): Název seznamu.

- `deleted` (boolean): Vždy `true`.

**Požadavek** `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"
}
```

---
Zdroj: https://emailit.com/cs/docs/api-reference/audiences/delete/