Seznamy kontaktů

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

Základní URLhttps://api.emailit.com/v2Autentizace Chyby Limity rychlosti

POST/audiences
GET/audiences/{id}
POST/audiences/{id}
GET/audiences
POST/audiences/{id}/merge
POST/audiences/bulk
DEL/audiences/{id}

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, nebo tak, že při vytvoření kontaktu předáte ID seznamu v poli audiences. Vyvolá událost audience.created. Viz Seznamy kontaktů.

Parametry v těle požadavku

namestringpovinné

Název seznamu, například Newsletter. Musí být ve workspace jedinečný.

visibilitystringvýchozí: private

public zobrazí seznam na stránce pro správu odběrů všem, private jen lidem, kteří jsou k němu přihlášení.

public_namestring | null

Název, který odběratelé vidí v e-mailech a na stránkách pro příjemce. Nejvýše 120 znaků. Při null se zobrazí name.

public_descriptionstring | null

Jeden řádek zobrazený na stránce pro správu odběrů. Nejvýše 500 znaků.

double_opt_inboolean | object

true, nebo false, případně objekt s kterýmikoli z polí enabled, redirect_url (URL http(s), na kterou lidé po potvrzení přejdou, nebo null) a email. email přijímá from, reply_to, subject, design (default, nebo custom), heading, body, button_label a footer. Pole, která vynecháte, si ponechají uloženou hodnotu. Zapnutí vyžaduje adresu from na ověřené odesílací doméně. Viz Double opt-in.

confirmation_emailboolean | object

true, nebo false, případně objekt s poli enabled a email; email přijímá stejná pole jako výše a navíc button_url.

unengagedobject

exclude (vynechávat neaktivní odběratele v kampaních) a days (od 30 do 1 825).

Odpověď

Vrací 201 s novým seznamem kontaktů včetně jeho nastavení, jak je popisuje Načtení seznamu kontaktů:

objectstring

Vždy audience.

idstring

ID seznamu kontaktů.

namestring

Název seznamu.

tokenstring

Token v URL pro přihlášení seznamu. Uchovejte ho v tajnosti.

visibilitystring

public, nebo private.

created_atstring

Kdy byl seznam vytvořen.

updated_atstring

Kdy se seznam naposledy změnil.

POST/audiences

JavaScript

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

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

Python

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

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

PHP

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

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

Ruby

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

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

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

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

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

import com.emailit.*;
import com.emailit.params.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject audience = emailit.audiences().create(
  AudienceCreateParams.builder()
    .setName("Newsletter")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

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

PHP

use Emailit\Laravel\Facades\Emailit;

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

Terminal

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

JSON

{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "visibility": "private",
  "public_name": null,
  "public_description": null,
  "double_opt_in": {
    "enabled": false,
    "redirect_url": null,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "Confirm your subscription to {{audience_name}}",
      "design": "default",
      "heading": "Please confirm your subscription",
      "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
      "button_label": "Confirm subscription",
      "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm.",
      "source": null
    }
  },
  "confirmation_email": {
    "enabled": false,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "You're subscribed to {{audience_name}}",
      "design": "default",
      "heading": "You're subscribed",
      "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
      "button_label": "",
      "button_url": "",
      "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
      "source": null
    }
  },
  "unengaged": { "exclude": false, "days": 365 },
  "archived": false,
  "archived_at": null,
  "subscribers_count": 0,
  "created_at": "2026-10-01T10:02:44.613207Z",
  "updated_at": "2026-10-01T10:02:44.613207Z"
}

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

Načtení seznamu kontaktů

Načte seznam kontaktů s jeho nastavením, počty a veřejným tokenem.

GET/audiences/{id}

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

Parametry v cestě

idstringpovinné

ID seznamu kontaktů (aud_…), nebo jeho přesný název zakódovaný do URL.

Odpověď

Vrací objekt seznamu kontaktů.

objectstring

Vždy audience.

idstring

ID seznamu kontaktů.

namestring

Název seznamu.

tokenstring

Token v URL pro přihlášení seznamu. Uchovejte ho v tajnosti: kdokoli, kdo ho má, může do seznamu přidávat lidi.

visibilitystring

public, nebo private. Veřejné seznamy se na stránce pro správu odběrů zobrazují všem, soukromé jen lidem, kteří jsou k nim přihlášení.

public_namestring | null

Název, který vidí odběratelé, nebo null, pokud se má zobrazit name.

public_descriptionstring | null

Popis zobrazený na stránce pro správu odběrů.

double_opt_inobject

enabled, redirect_url (kam lidé po potvrzení přejdou, nebo null) a email, tedy e-mail pro double opt-in s poli from, reply_to, subject, design (default, nebo custom), heading, body, button_label, footer a source (MJML vlastního designu, nebo null; výpisy ho vynechávají). Pole, která jste nikdy nenastavili, obsahují výchozí hodnoty.

confirmation_emailobject

enabled a email, tedy potvrzovací e-mail, se stejnými poli jako výše a navíc button_url.

unengagedobject

exclude (jestli kampaně vynechávají neaktivní odběratele) a days (období, ve výchozím stavu 365).

archivedboolean

Jestli je seznam archivovaný. archived_at obsahuje čas archivace, nebo null.

subscribers_countinteger

Kolik kontaktů je v seznamu, včetně odhlášených.

usageobject

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.

unengaged_countinteger

Kolik přihlášených členů se právě teď počítá jako neaktivní.

pending_confirmations_countinteger

Kolik žádostí o double opt-in čeká na kliknutí, bez těch, jejichž platnost vypršela.

created_atstring

Kdy byl seznam vytvořen.

updated_atstring

Kdy se seznam naposledy změnil.

GET/audiences/{id}

JavaScript

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

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

Python

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

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

PHP

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

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

Ruby

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

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

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

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

Rust

use emailit::Emailit;

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

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

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

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

using Emailit;

var emailit = new EmailitClient("your_api_key");

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

PHP

use Emailit\Laravel\Facades\Emailit;

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

Terminal

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

JSON

{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Newsletter",
  "visibility": "public",
  "public_name": "Monthly newsletter",
  "public_description": "Product news and tips, once a month.",
  "double_opt_in": {
    "enabled": true,
    "redirect_url": null,
    "email": {
      "from": "News <news@example.com>",
      "reply_to": null,
      "subject": "Confirm your subscription to {{audience_name}}",
      "design": "default",
      "heading": "Please confirm your subscription",
      "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
      "button_label": "Confirm subscription",
      "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm.",
      "source": null
    }
  },
  "confirmation_email": {
    "enabled": false,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "You're subscribed to {{audience_name}}",
      "design": "default",
      "heading": "You're subscribed",
      "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
      "button_label": "",
      "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
      "button_url": "",
      "source": null
    }
  },
  "unengaged": { "exclude": true, "days": 365 },
  "archived": false,
  "archived_at": null,
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "subscribers_count": 1284,
  "unengaged_count": 212,
  "pending_confirmations_count": 3,
  "usage": {
    "used": 1284,
    "limit": 50000,
    "plan": "pro"
  },
  "created_at": "2026-10-01T10:02:44.000000Z",
  "updated_at": "2026-10-01T10:02:44.000000Z"
}

JSON

{
  "error": "Audience not found"
}

Úprava seznamu kontaktů

Přejmenuje seznam kontaktů nebo změní jeho nastavení.

POST/audiences/{id}

Vyžaduje API klíč s oprávněním full. Pošlete jen pole, která chcete změnit. ID, token ani odběratelé se nezmění. Vyvolá událost audience.updated.

Parametry v cestě

idstringpovinné

ID seznamu kontaktů, nebo jeho aktuální název.

Parametry v těle požadavku

namestring

Nový název. Musí být ve workspace jedinečný.

visibilitystring

public zobrazí seznam na stránce pro správu odběrů všem, private jen lidem, kteří jsou k němu přihlášení.

public_namestring | null

Název, který odběratelé vidí v e-mailech a na stránkách pro příjemce. Nejvýše 120 znaků. Při null se zobrazí name.

public_descriptionstring | null

Jeden řádek zobrazený na stránce pro správu odběrů. Nejvýše 500 znaků.

double_opt_inboolean | object

confirmation_emailboolean | object

true, nebo false, případně objekt s poli enabled a email; email přijímá stejná pole jako výše a navíc button_url.

unengagedobject

exclude (vynechávat neaktivní odběratele v kampaních) a days (od 30 do 1 825).

archivedboolean

true seznam archivuje, false ho vrátí z archivu. Viz Archivace seznamu.

Nastavení vlastního designu MJML přes email.source je součástí alfaverze MJML a pro API klíče vrací 403 s error: "mjml_alpha".

Odpověď

Vrací seznam kontaktů s jeho nastavením, stejně jako Načtení seznamu kontaktů. V této odpovědi je subscribers_count vždy 0 a počty chybí; ty zjistíte endpointem Načtení seznamu kontaktů. Neplatné nastavení vrací 422 s objektem errors, jehož klíči jsou názvy polí, například double_opt_in.email.from.

POST/audiences/{id}

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

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

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

PHP

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

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

Ruby

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

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

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

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

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

using Emailit;

var emailit = new EmailitClient("your_api_key");

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

PHP

use Emailit\Laravel\Facades\Emailit;

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

Terminal

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

JSON

{
  "object": "audience",
  "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "name": "Weekly newsletter",
  "token": "4KXUJdXRVlVgbkWQm4GHLy8BleP",
  "visibility": "public",
  "public_name": "Weekly newsletter",
  "public_description": null,
  "double_opt_in": {
    "enabled": true,
    "redirect_url": null,
    "email": {
      "from": "News <news@example.com>",
      "reply_to": null,
      "subject": "Confirm your subscription to {{audience_name}}",
      "design": "default",
      "heading": "Please confirm your subscription",
      "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
      "button_label": "Confirm subscription",
      "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm.",
      "source": null
    }
  },
  "confirmation_email": {
    "enabled": false,
    "email": {
      "from": null,
      "reply_to": null,
      "subject": "You're subscribed to {{audience_name}}",
      "design": "default",
      "heading": "You're subscribed",
      "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
      "button_label": "",
      "button_url": "",
      "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
      "source": null
    }
  },
  "unengaged": {
    "exclude": false,
    "days": 365
  },
  "archived": false,
  "archived_at": null,
  "subscribers_count": 0,
  "created_at": "2026-10-01T10:02:44.000000Z",
  "updated_at": "2026-10-01T14:31:09.000000Z"
}

JSON

{
  "error": "No valid fields provided for update. Provide at least one of: name, visibility, public_name, public_description, double_opt_in, confirmation_email, unengaged, archived"
}

JSON

{
  "message": "Validation failed.",
  "errors": {
    "double_opt_in.email.from": ["Use an address on a verified sending domain of this workspace."]
  }
}

JSON

{
  "error": "Audience not found"
}

JSON

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

Výpis seznamů kontaktů

Vrátí stránku seznamů kontaktů, od nejnovějších. Archivované seznamy se vynechávají, pokud o ně výslovně nepožádáte.

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ů.

Parametry dotazu

pageintegervýchozí: 1

Stránka, kterou chcete načíst.

limitintegervýchozí: 10

Počet seznamů na stránce, od 1 do 100.

searchstring

Hledá v názvu seznamu bez ohledu na velikost písmen.

archivedstringvýchozí: false

false pro aktivní seznamy, true jen pro archivované, all pro oboje.

visibilitystring

public, nebo private, pokud chcete vypsat jen tyto seznamy.

matchstringvýchozí: all

all, nebo or. Jak se kombinují filtry níže.

orderstring

name, public_name, visibility, subscribers_count nebo created_at.

directionstring

asc, nebo desc.

Filtry

Filtry přidávejte ve tvaru key.condition=value, například name.contains=news. Viz Filtrování.

Klíč	Typ
`name`	string
`public_name`	string
`visibility`	enum: `public`, `private`
`subscribers_count`	number
`created_at`	date

Odpověď

dataobject[]

Seznamy kontaktů na této stránce, každý s object, id, name, nastavením (visibility, public_name, public_description, double_opt_in, confirmation_email, unengaged, archived, archived_at), subscribers_count, usage, created_at a updated_at. Viz Načtení seznamu kontaktů. Objekty email ve výpisu neobsahují pole source.

total_recordsinteger

Počet seznamů kontaktů, které odpovídají vyhledávání, filtrům a parametru archived.

next_page_urlstring | null

Cesta k další stránce, nebo null. Viz Stránkování.

previous_page_urlstring | null

Cesta k předchozí stránce, nebo null.

GET/audiences

JavaScript

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

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

Python

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

audiences = client.audiences.list()

PHP

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

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

Ruby

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

audiences = client.audiences.list

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

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

Rust

use emailit::Emailit;

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

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

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

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

using Emailit;

var emailit = new EmailitClient("your_api_key");

var audiences = emailit.Audiences.List();

PHP

use Emailit\Laravel\Facades\Emailit;

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

Terminal

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

JSON

{
  "data": [
    {
      "object": "audience",
      "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "name": "Newsletter",
      "visibility": "public",
      "public_name": "Monthly newsletter",
      "public_description": "Product news and tips, once a month.",
      "double_opt_in": {
        "enabled": true,
        "redirect_url": null,
        "email": {
          "from": "News <news@example.com>",
          "reply_to": null,
          "subject": "Confirm your subscription to {{audience_name}}",
          "design": "default",
          "heading": "Please confirm your subscription",
          "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
          "button_label": "Confirm subscription",
          "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm."
        }
      },
      "confirmation_email": {
        "enabled": false,
        "email": {
          "from": "News <news@example.com>",
          "reply_to": null,
          "subject": "You're subscribed to {{audience_name}}",
          "design": "default",
          "heading": "You're subscribed",
          "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
          "button_label": "",
          "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
          "button_url": ""
        }
      },
      "unengaged": {
        "exclude": false,
        "days": 365
      },
      "archived": false,
      "archived_at": null,
      "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",
      "visibility": "private",
      "public_name": null,
      "public_description": null,
      "double_opt_in": {
        "enabled": false,
        "redirect_url": null,
        "email": {
          "from": null,
          "reply_to": null,
          "subject": "Confirm your subscription to {{audience_name}}",
          "design": "default",
          "heading": "Please confirm your subscription",
          "body": "Hi {{first_name|\"there\"}},\n\nYou asked to join {{audience_name}}. Confirm your email address to start getting our emails.",
          "button_label": "Confirm subscription",
          "footer": "Button not working? Open this link: <a href=\"{{confirm_url}}\">{{confirm_url}}</a>\n\nIf you did not ask to subscribe, ignore this email. You will not be added unless you confirm."
        }
      },
      "confirmation_email": {
        "enabled": false,
        "email": {
          "from": null,
          "reply_to": null,
          "subject": "You're subscribed to {{audience_name}}",
          "design": "default",
          "heading": "You're subscribed",
          "body": "Hi {{first_name|\"there\"}},\n\nThanks for joining {{audience_name}}. You will hear from us soon.",
          "button_label": "",
          "footer": "You are getting this email because you subscribed to {{audience_name}}. <a href=\"{{manage_subscriptions_url}}\">Manage subscriptions</a>",
          "button_url": ""
        }
      },
      "unengaged": {
        "exclude": false,
        "days": 365
      },
      "archived": false,
      "archived_at": null,
      "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
}

Sloučení seznamů kontaktů

Zkopíruje do tohoto seznamu kontaktů odběratele jiných seznamů.

POST/audiences/{id}/merge

Vyžaduje API klíč s oprávněním full. Lidé, kteří už v cílovém seznamu jsou, si v něm ponechají svůj stav, takže nikdo, kdo se odhlásil, se znovu nepřihlásí. Osoba, která je ve více slučovaných seznamech, se přidá se zapnutým Subscribed, pokud je přihlášená alespoň v jednom z nich. S delete_sources se sloučené seznamy potom smažou a kampaně, jejichž odesílání ještě neskončilo (koncepty, naplánované kampaně, kampaně ve frontě, právě odesílané kampaně a A/B testy čekající na vítěze), se místo toho pošlou na cílový seznam. Pokud taková kampaň jeden ze sloučených seznamů zahrnovala a jiný vylučovala, cílový seznam zůstane zahrnutý. Segmenty, které čerpají ze smazaného seznamu nebo na něj mají pravidlo, místo něj použijí cílový seznam, stejně jako spouštěče, kroky, podmínky a podmínky ukončení automatizací, které ho uvádějí. Totéž platí pro formuláře, které do něj přidávají lidi nebo ho nabízejí k výběru, pro dosud nepotvrzené odkazy double opt-inu a pro spuštění automatizací čekající na podmínku, která se ho týká. Každé smazání vyvolá audience.deleted.

Sloučení nevyvolává události subscriber.*, nespouští automatizace a neposílá e-maily pro double opt-in ani potvrzovací e-maily. Pokud by noví odběratelé dostali cílový seznam přes limit odběratelů vašeho tarifu, nic se nesloučí a požadavek vrátí 422 s vaším usage. Neplatný vstup, například sloučení seznamu do sebe sama, vrací také 422. Viz Sloučení seznamů.

Parametry v cestě

idstringpovinné

Seznam, do kterého se slučuje, podle ID nebo názvu.

Parametry v těle požadavku

source_idsstring[]povinné

ID seznamů, které chcete sloučit, od 1 do 50. Nesmí obsahovat cílový seznam.

delete_sourcesbooleanvýchozí: false

Po zkopírování odběratelů sloučené seznamy smaže.

Odpověď

objectstring

Vždy audience_merge.

audienceobject

Cílový seznam: object, id, name a jeho nový subscribers_count.

addedinteger

Kolik lidí přibylo do cílového seznamu.

already_in_audienceinteger

Kolik lidí ze slučovaných seznamů už v cílovém seznamu bylo a ponechalo si svůj stav.

deleted_source_idsstring[]

Seznamy, které se smazaly, nebo prázdné pole.

POST/audiences/{id}/merge

JavaScript

const response = await fetch('https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/merge', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    source_ids: ['aud_4KOlh9t2uw5od4qypqCtyrZyDq2'],
    delete_sources: true
  })
});

const { added, already_in_audience } = await response.json();

Terminal

curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/merge \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source_ids": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"], "delete_sources": true}'

JSON

{
  "object": "audience_merge",
  "audience": {
    "object": "audience",
    "id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
    "name": "Newsletter",
    "subscribers_count": 1503
  },
  "added": 219,
  "already_in_audience": 93,
  "deleted_source_ids": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

JSON

{
  "error": "One or more audiences were not found",
  "missing": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

JSON

{
  "message": "Validation failed.",
  "errors": {
    "source_ids": ["An audience cannot be merged into itself."]
  }
}

Hromadná úprava seznamů kontaktů

Archivuje, vrátí z archivu nebo smaže několik seznamů kontaktů najednou.

POST/audiences/bulk

Vyžaduje API klíč s oprávněním full. Všechna ID musí patřit do workspace, jinak se nic nezmění a požadavek vrátí 404 s chybějícími ID v poli missing. Archivace a vrácení z archivu vyvolají audience.updated; smazání vyvolá audience.deleted a odebere odběratele seznamů, stejně jako Smazání seznamu kontaktů. Viz Archivace seznamu.

Parametry v těle požadavku

actionstringpovinné

archive, unarchive nebo delete.

idsstring[]povinné

ID seznamů kontaktů, od 1 do 100.

Odpověď

objectstring

Vždy audience_bulk.

actionstring

Akce, kterou jste poslali.

processedinteger

Kolik seznamů se našlo.

changedinteger

Kolik se jich skutečně změnilo. Archivace seznamu, který už archivovaný je, se nepočítá.

idsstring[]

ID, která jste poslali.

POST/audiences/bulk

JavaScript

const response = await fetch('https://api.emailit.com/v2/audiences/bulk', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: 'archive',
    ids: ['aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'aud_4KOlh9t2uw5od4qypqCtyrZyDq2']
  })
});

const { changed } = await response.json();

Terminal

curl -X POST https://api.emailit.com/v2/audiences/bulk \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action": "archive", "ids": ["aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]}'

JSON

{
  "object": "audience_bulk",
  "action": "archive",
  "processed": 2,
  "changed": 2,
  "ids": ["aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

JSON

{
  "error": "One or more audiences were not found",
  "missing": ["aud_4KOlh9t2uw5od4qypqCtyrZyDq2"]
}

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 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ě

idstringpovinné

ID seznamu kontaktů, nebo jeho název.

Odpověď

objectstring

Vždy audience.

idstring

ID smazaného seznamu kontaktů.

namestring

Název seznamu.

deletedboolean

Vždy true.

DELETE/audiences/{id}

JavaScript

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

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

Python

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

client.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")

PHP

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

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

Ruby

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

client.audiences.delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2")

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

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

Rust

use emailit::Emailit;

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

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

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

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

using Emailit;

var emailit = new EmailitClient("your_api_key");

emailit.Audiences.Delete("aud_4KOlh9t2uw5od4qypqCtyrZyDq2");

PHP

use Emailit\Laravel\Facades\Emailit;

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

Terminal

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

JSON

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

JSON

{
  "error": "Audience not found"
}