Kontaktlisten

Abonnentenlisten für Kampagnen und Anmeldeformulare verwalten.

Basis-URLhttps://api.emailit.com/v2Authentifizierung Fehler Rate Limits

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

Kontaktliste erstellen

Erstellt eine leere Kontaktliste.

POST/audiences

Erfordert einen API-Schlüssel mit dem Scope full. Personen fügen Sie mit Abonnent hinzufügen hinzu oder indem Sie beim Erstellen eines Kontakts die ID der Kontaktliste in audiences übergeben. Löst das Event audience.created aus. Siehe Kontaktlisten.

Body-Parameter

namestringerforderlich

Der Name der Kontaktliste, etwa Newsletter. Muss im Workspace eindeutig sein.

visibilitystringStandardwert: private

public zeigt die Kontaktliste auf der Seite zur Abonnementverwaltung allen an; private nur Personen, die bei ihr angemeldet sind.

public_namestring | null

Der Name, den Abonnenten in E-Mails und auf Seiten für Empfänger sehen. Bis zu 120 Zeichen. Bei null wird name angezeigt.

public_descriptionstring | null

Eine Zeile, die auf der Seite zur Abonnementverwaltung angezeigt wird. Bis zu 500 Zeichen.

double_opt_inboolean | object

true oder false oder ein Objekt mit beliebigen der Felder enabled, redirect_url (eine http(s)-URL, zu der Personen nach der Bestätigung weitergeleitet werden, oder null) und email. email akzeptiert from, reply_to, subject, design (default oder custom), heading, body, button_label und footer. Felder, die Sie weglassen, behalten ihren gespeicherten Wert. Zum Aktivieren ist eine Adresse in from auf einer verifizierten Versanddomain nötig. Siehe Double-Opt-in.

confirmation_emailboolean | object

true oder false oder ein Objekt mit enabled und email. email akzeptiert dieselben Felder wie oben und zusätzlich button_url.

unengagedobject

exclude (inaktive Abonnenten bei Kampagnen überspringen) und days (30 bis 1.825).

Rückgabe

Gibt 201 mit der neuen Kontaktliste zurück, einschließlich ihrer Einstellungen, wie unter Kontaktliste abrufen beschrieben:

objectstring

Immer audience.

idstring

Die ID der Kontaktliste.

namestring

Der Name der Kontaktliste.

tokenstring

Das Token in der Anmelde-URL der Kontaktliste. Halten Sie es geheim.

visibilitystring

public oder private.

created_atstring

Zeitpunkt der Erstellung der Kontaktliste.

updated_atstring

Zeitpunkt der letzten Änderung der Kontaktliste.

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

Kontaktliste abrufen

Ruft eine Kontaktliste mit ihren Einstellungen, Zählern und ihrem öffentlichen Token ab.

GET/audiences/{id}

Erfordert einen API-Schlüssel mit dem Scope full.

Pfadparameter

idstringerforderlich

Die ID der Kontaktliste (aud_…) oder ihr exakter Name, URL-kodiert.

Rückgabe

Gibt das Kontaktlisten-Objekt zurück.

objectstring

Immer audience.

idstring

Die ID der Kontaktliste.

namestring

Der Name der Kontaktliste.

tokenstring

Das Token in der Anmelde-URL der Kontaktliste. Halten Sie es geheim: Wer es kennt, kann Personen zur Kontaktliste hinzufügen.

visibilitystring

public oder private. Öffentliche Kontaktlisten werden auf der Seite zur Abonnementverwaltung allen angezeigt, private nur Personen, die bei ihnen angemeldet sind.

public_namestring | null

Der Name, den Abonnenten sehen, oder null, um name anzuzeigen.

public_descriptionstring | null

Die Beschreibung, die auf der Seite zur Abonnementverwaltung angezeigt wird.

double_opt_inobject

enabled, redirect_url (wohin Personen nach der Bestätigung weitergeleitet werden, oder null) und email, die Double-Opt-in-E-Mail mit from, reply_to, subject, design (default oder custom), heading, body, button_label, footer und source (das MJML eines eigenen Designs oder null; in Listen fehlt es). Felder, die Sie nie gesetzt haben, enthalten die Standardwerte.

confirmation_emailobject

enabled und email, die Anmeldebestätigung, mit denselben Feldern wie oben und zusätzlich button_url.

unengagedobject

exclude (ob Kampagnen inaktive Abonnenten überspringen) und days (das Zeitfenster, standardmäßig 365).

archivedboolean

Ob die Kontaktliste archiviert ist. archived_at enthält den Zeitpunkt oder null.

subscribers_countinteger

Wie viele Kontakte in der Kontaktliste sind, abgemeldete eingeschlossen.

usageobject

used (dieselbe Anzahl), limit (die maximale Anzahl Abonnenten pro Kontaktliste in Ihrem Tarif oder null ohne Limit) und plan. Siehe Limits.

unengaged_countinteger

Wie viele angemeldete Mitglieder gerade als inaktiv gelten.

pending_confirmations_countinteger

Wie viele Double-Opt-in-Anfragen auf einen Klick warten, abgelaufene nicht mitgezählt.

created_atstring

Zeitpunkt der Erstellung der Kontaktliste.

updated_atstring

Zeitpunkt der letzten Änderung der Kontaktliste.

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

Kontaktliste aktualisieren

Benennt eine Kontaktliste um oder ändert ihre Einstellungen.

POST/audiences/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Senden Sie nur die Felder, die Sie ändern möchten. ID, Token und Abonnenten ändern sich nicht. Löst das Event audience.updated aus.

Pfadparameter

idstringerforderlich

Die ID der Kontaktliste oder ihr aktueller Name.

Body-Parameter

namestring

Der neue Name. Muss im Workspace eindeutig sein.

visibilitystring

public zeigt die Kontaktliste auf der Seite zur Abonnementverwaltung allen an; private nur Personen, die bei ihr angemeldet sind.

public_namestring | null

Der Name, den Abonnenten in E-Mails und auf Seiten für Empfänger sehen. Bis zu 120 Zeichen. Bei null wird name angezeigt.

public_descriptionstring | null

Eine Zeile, die auf der Seite zur Abonnementverwaltung angezeigt wird. Bis zu 500 Zeichen.

double_opt_inboolean | object

confirmation_emailboolean | object

true oder false oder ein Objekt mit enabled und email. email akzeptiert dieselben Felder wie oben und zusätzlich button_url.

unengagedobject

exclude (inaktive Abonnenten bei Kampagnen überspringen) und days (30 bis 1.825).

archivedboolean

true archiviert die Kontaktliste, false hebt die Archivierung auf. Siehe Kontaktliste archivieren.

Ein eigenes MJML-Design mit email.source festzulegen, ist Teil der MJML-Alpha und gibt für API-Schlüssel 403 mit error: "mjml_alpha" zurück.

Rückgabe

Gibt die Kontaktliste mit ihren Einstellungen zurück, wie bei Kontaktliste abrufen. In dieser Antwort ist subscribers_count immer 0, und die Zähler fehlen; dafür nutzen Sie Kontaktliste abrufen. Ungültige Einstellungen geben 422 mit einem Objekt errors zurück, dessen Schlüssel die Felder sind, etwa 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"
}

Kontaktlisten auflisten

Gibt eine Seite mit Kontaktlisten zurück, die neuesten zuerst. Archivierte Kontaktlisten werden weggelassen, sofern Sie sie nicht anfordern.

GET/audiences

Erfordert einen API-Schlüssel mit dem Scope full. Die Listeneinträge enthalten nicht das token der Kontaktliste; dafür nutzen Sie Kontaktliste abrufen.

Query-Parameter

pageintegerStandardwert: 1

Die abzurufende Seite.

limitintegerStandardwert: 10

Kontaktlisten pro Seite, von 1 bis 100.

searchstring

Abgleich mit dem Namen der Kontaktliste, ohne Beachtung der Groß-/Kleinschreibung.

archivedstringStandardwert: false

false für aktive Kontaktlisten, true nur für archivierte, all für beide.

visibilitystring

public oder private, um nur diese aufzulisten.

matchstringStandardwert: all

all oder or. Wie die Filter unten kombiniert werden.

orderstring

name, public_name, visibility, subscribers_count oder created_at.

directionstring

asc oder desc.

Filter

Fügen Sie Filter als key.condition=value hinzu, zum Beispiel name.contains=news. Siehe Filtern und Sortieren.

Schlüssel	Typ
`name`	string
`public_name`	string
`visibility`	enum: `public`, `private`
`subscribers_count`	number
`created_at`	date

Rückgabe

dataobject[]

Die Kontaktlisten auf dieser Seite, jeweils mit object, id, name, den Einstellungen (visibility, public_name, public_description, double_opt_in, confirmation_email, unengaged, archived, archived_at), subscribers_count, usage, created_at und updated_at. Siehe Kontaktliste abrufen. Die Objekte email lassen in Listen source weg.

total_recordsinteger

Die Anzahl der Kontaktlisten, die der Suche, den Filtern und archived entsprechen.

next_page_urlstring | null

Pfad der nächsten Seite oder null. Siehe Paginierung.

previous_page_urlstring | null

Pfad der vorherigen Seite oder 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
}

Kontaktlisten zusammenführen

Kopiert die Abonnenten anderer Kontaktlisten in diese.

POST/audiences/{id}/merge

Erfordert einen API-Schlüssel mit dem Scope full. Personen, die bereits auf der Zielliste stehen, behalten dort ihren Status. So wird niemand, der sich abgemeldet hat, erneut angemeldet. Eine Person auf mehreren der zusammengeführten Kontaktlisten tritt mit aktiviertem Subscribed bei, wenn sie bei mindestens einer davon angemeldet ist. Mit delete_sources werden die zusammengeführten Kontaktlisten danach gelöscht, und Kampagnen, deren Versand noch nicht abgeschlossen ist (Entwürfe, geplante Kampagnen, Kampagnen in der Warteschlange und Kampagnen im Versand sowie A/B-Tests, die auf ihre Gewinnervariante warten), senden stattdessen an die Zielliste. Hat eine solche Kampagne eine zusammengeführte Kontaktliste eingeschlossen und eine andere ausgeschlossen, bleibt die Zielliste eingeschlossen. Segmente, die aus einer gelöschten Kontaktliste schöpfen oder eine Regel zu ihr haben, verwenden stattdessen die Zielliste, ebenso Trigger, Schritte, Bedingungen und Ausstiegsbedingungen von Automatisierungen, die sie nennen. Das gilt auch für Formulare, die Personen zu ihr hinzufügen oder sie zur Auswahl anbieten, für Double-Opt-in-Links, die noch nicht bestätigt wurden, und für Durchläufe von Automatisierungen, die auf eine Bedingung zu ihr warten. Jede Löschung löst das Event audience.deleted aus.

Zusammenführen löst keine subscriber.*-Events aus, startet keine Automatisierungen und sendet weder Double-Opt-in-E-Mails noch Anmeldebestätigungen. Würden die neuen Abonnenten die Zielliste über das Abonnentenlimit Ihres Tarifs bringen, wird nichts zusammengeführt, und die Anfrage gibt 422 mit Ihrer Nutzung in usage zurück. Ungültige Eingaben, etwa das Zusammenführen einer Kontaktliste mit sich selbst, geben ebenfalls 422 zurück. Siehe Kontaktlisten zusammenführen.

Pfadparameter

idstringerforderlich

Die Kontaktliste, in die zusammengeführt wird, per ID oder Name.

Body-Parameter

source_idsstring[]erforderlich

IDs der zusammenzuführenden Kontaktlisten, von 1 bis 50. Darf die Zielliste nicht enthalten.

delete_sourcesbooleanStandardwert: false

Löscht die zusammengeführten Kontaktlisten, nachdem ihre Abonnenten kopiert wurden.

Rückgabe

objectstring

Immer audience_merge.

audienceobject

Die Zielliste: object, id, name und ihr neuer subscribers_count.

addedinteger

Wie viele Personen der Zielliste beigetreten sind.

already_in_audienceinteger

Wie viele Personen aus den zusammengeführten Kontaktlisten bereits auf der Zielliste standen und ihren Status behalten haben.

deleted_source_idsstring[]

Die gelöschten Kontaktlisten oder ein leeres Array.

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

Kontaktlisten gesammelt aktualisieren

Archiviert mehrere Kontaktlisten auf einmal, hebt ihre Archivierung auf oder löscht sie.

POST/audiences/bulk

Erfordert einen API-Schlüssel mit dem Scope full. Jede ID muss zum Workspace gehören, sonst ändert sich nichts, und die Anfrage gibt 404 mit den fehlenden IDs in missing zurück. Archivieren und das Aufheben der Archivierung lösen audience.updated aus; Löschen löst audience.deleted aus und entfernt die Abonnenten der Kontaktlisten, wie Kontaktliste löschen. Siehe Kontaktliste archivieren.

Body-Parameter

actionstringerforderlich

archive, unarchive oder delete.

idsstring[]erforderlich

IDs von Kontaktlisten, von 1 bis 100.

Rückgabe

objectstring

Immer audience_bulk.

actionstring

Die gesendete Aktion.

processedinteger

Wie viele Kontaktlisten gefunden wurden.

changedinteger

Wie viele sich tatsächlich geändert haben. Das Archivieren einer bereits archivierten Kontaktliste zählt nicht.

idsstring[]

Die gesendeten IDs.

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

Kontaktliste löschen

Löscht eine Kontaktliste endgültig und entfernt alle Abonnenten daraus.

DELETE/audiences/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Die Mitgliedschaften der Abonnenten werden mit der Kontaktliste gelöscht, die Kontakte bleiben aber in Ihrem Workspace und in ihren anderen Kontaktlisten. Die gehostete Anmelde-URL der Kontaktliste funktioniert nicht mehr. Löst das Event audience.deleted aus. Für die entfernten Mitgliedschaften werden keine subscriber.deleted-Events gesendet.

Pfadparameter

idstringerforderlich

Die ID der Kontaktliste oder ihr Name.

Rückgabe

objectstring

Immer audience.

idstring

Die ID der gelöschten Kontaktliste.

namestring

Der Name der Kontaktliste.

deletedboolean

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