Abonnenten

Abonnenten einer Kontaktliste hinzufügen, aktualisieren und entfernen.

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

POST/audiences/{audience_id}/subscribers
GET/audiences/{audience_id}/subscribers/{id}
POST/audiences/{audience_id}/subscribers/{id}
GET/audiences/{audience_id}/subscribers
DEL/audiences/{audience_id}/subscribers/{id}

Abonnent hinzufügen

Fügt einer Kontaktliste einen Kontakt per E-Mail-Adresse hinzu.

POST/audiences/{audience_id}/subscribers

Erfordert einen API-Schlüssel mit dem Scope full. Gibt es noch keinen Kontakt mit dieser E-Mail-Adresse, erstellt Emailit einen. Existiert der Kontakt, überschreiben die gesendeten Namen und eigenen Felder seine aktuellen Werte. Ein Kontakt, der sich von der Kontaktliste abgemeldet hatte, wird erneut angemeldet und die Antwort ist 200; für einen bereits angemeldeten Kontakt gibt die Anfrage 409 zurück.

Jede Kontaktliste kann so viele Abonnenten aufnehmen, wie Ihr Tarif erlaubt; darüber hinaus gibt die Anfrage 422 mit Ihrer Nutzung in usage zurück. Löst subscriber.created aus, bei einer erneuten Anmeldung subscriber.updated und subscriber.resubscribed.

Pfadparameter

audience_idstringerforderlich

Die ID der Kontaktliste (aud_…) oder ihr Name.

Body-Parameter

emailstringerforderlich

Die anzumeldende E-Mail-Adresse. Wird in Kleinbuchstaben gespeichert.

first_namestring

Der Vorname des Kontakts.

last_namestring

Der Nachname des Kontakts.

custom_fieldsobject

Werte eigener Felder nach Schlüssel, etwa {"company": "Analytical Engines"}. Ersetzt die bestehenden eigenen Felder des Kontakts.

Rückgabe

Gibt 201 mit dem Abonnenten-Objekt zurück oder 200, wenn ein abgemeldeter Kontakt erneut angemeldet wurde.

POST/audiences/{audience_id}/subscribers

JavaScript

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

const subscriber = await emailit.subscribers.create('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', {
  email: 'ada@example.com',
  first_name: 'Ada',
  last_name: 'Lovelace',
});

Python

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

subscriber = client.subscribers.create("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", {
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
})

PHP

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

$subscriber = $emailit->subscribers()->create('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', [
  'email' => 'ada@example.com',
  'first_name' => 'Ada',
  'last_name' => 'Lovelace',
]);

Ruby

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

subscriber = client.subscribers.create("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  email: "ada@example.com",
  first_name: "Ada",
  last_name: "Lovelace"
)

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

subscriber, err := client.Subscribers.Create("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", &emailit.CreateSubscriberRequest{
  Email:     "ada@example.com",
  FirstName: "Ada",
  LastName:  "Lovelace",
})

Rust

use emailit::Emailit;
use emailit::types::CreateSubscriberParams;

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

let subscriber = emailit.subscribers.create("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  CreateSubscriberParams::new("ada@example.com")
    .with_first_name("Ada")
    .with_last_name("Lovelace")
).await?;

Java

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

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject subscriber = emailit.subscribers().create("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  SubscriberCreateParams.builder()
    .setEmail("ada@example.com")
    .setFirstName("Ada")
    .setLastName("Lovelace")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var subscriber = emailit.Subscribers.Create("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", new SubscriberCreateOptions {
  Email = "ada@example.com",
  FirstName = "Ada",
  LastName = "Lovelace",
});

PHP

use Emailit\Laravel\Facades\Emailit;

$subscriber = Emailit::subscribers()->create('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', [
  'email' => 'ada@example.com',
  'first_name' => 'Ada',
  'last_name' => 'Lovelace',
]);

Terminal

curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ada@example.com",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "custom_fields": { "company": "Analytical Engines" }
  }'

JSON

{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields": {
    "company": "Analytical Engines"
  },
  "subscribed": true,
  "subscribed_at": "2026-10-01T10:20:31.000000Z",
  "unsubscribed_at": null,
  "created_at": "2026-10-01T10:20:31.000000Z",
  "updated_at": "2026-10-01T10:20:31.000000Z"
}

JSON

{
  "error": "Audience not found"
}

JSON

{
  "error": "Contact is already subscribed to this audience",
  "existing": {
    "object": "subscriber",
    "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
    "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
    "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
    "email": "ada@example.com",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "custom_fields": { "company": "Analytical Engines" },
    "subscribed": true,
    "subscribed_at": "2026-10-01T10:20:31.000Z",
    "unsubscribed_at": null,
    "created_at": "2026-10-01T10:20:31.000Z",
    "updated_at": "2026-10-01T10:20:31.000Z"
  }
}

JSON

{
  "error": "Pro includes 50,000 subscribers per audience.",
  "usage": {
    "used": 50000,
    "limit": 50000,
    "plan": "pro"
  }
}

Abonnent abrufen

Ruft die Mitgliedschaft eines Kontakts in einer Kontaktliste ab.

GET/audiences/{audience_id}/subscribers/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Ein Abonnent verknüpft einen Kontakt mit einer Kontaktliste. E-Mail-Adresse, Namen und eigene Felder gehören zum Kontakt, subscribed gilt nur für diese Kontaktliste.

Pfadparameter

audience_idstringerforderlich

Die ID der Kontaktliste (aud_…) oder ihr Name.

idstringerforderlich

Die ID des Abonnenten (sub_…) oder die E-Mail-Adresse des Kontakts, URL-kodiert.

Rückgabe

Gibt das Abonnenten-Objekt zurück.

objectstring

Immer subscriber.

idstring

Die ID des Abonnenten.

audience_idstring

Die ID der Kontaktliste.

contact_idstring

Die ID des Kontakts.

emailstring

Die E-Mail-Adresse des Kontakts.

first_namestring | null

Der Vorname des Kontakts.

last_namestring | null

Der Nachname des Kontakts.

custom_fieldsobject | null

Die Werte der eigenen Felder des Kontakts.

subscribedboolean

true, wenn der Kontakt bei dieser Kontaktliste angemeldet ist, false, wenn er sich abgemeldet hat.

subscribed_atstring | null

Zeitpunkt der letzten Anmeldung des Kontakts.

unsubscribed_atstring | null

Zeitpunkt der Abmeldung des Kontakts oder null.

created_atstring

Zeitpunkt, zu dem der Kontakt in die Kontaktliste aufgenommen wurde.

updated_atstring

Zeitpunkt der letzten Änderung der Mitgliedschaft.

GET/audiences/{audience_id}/subscribers/{id}

JavaScript

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

const subscriber = await emailit.subscribers.get('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo');

Python

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

subscriber = client.subscribers.get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo")

PHP

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

$subscriber = $emailit->subscribers()->get('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo');

Ruby

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

subscriber = client.subscribers.get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo")

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

subscriber, err := client.Subscribers.Get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo")

Rust

use emailit::Emailit;

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

let subscriber = emailit.subscribers.get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo").await?;

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject subscriber = emailit.subscribers().get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo");

using Emailit;

var emailit = new EmailitClient("your_api_key");

var subscriber = emailit.Subscribers.Get("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo");

PHP

use Emailit\Laravel\Facades\Emailit;

$subscriber = Emailit::subscribers()->get('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo');

Terminal

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

JSON

{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields": {
    "company": "Analytical Engines"
  },
  "subscribed": true,
  "subscribed_at": "2026-10-01T10:20:31.000000Z",
  "unsubscribed_at": null,
  "created_at": "2026-10-01T10:20:31.000000Z",
  "updated_at": "2026-10-01T10:20:31.000000Z"
}

JSON

{
  "error": "Subscriber not found"
}

Abonnent aktualisieren

Ändert den Status eines Abonnenten in der Kontaktliste oder die Daten seines Kontakts.

POST/audiences/{audience_id}/subscribers/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Senden Sie nur die Felder, die Sie ändern möchten. subscribed gilt nur für diese Kontaktliste. email, first_name, last_name und custom_fields ändern den Kontakt selbst, daher zeigt sich die Änderung in jeder Kontaktliste, zu der der Kontakt gehört. Löst das Event subscriber.updated aus.

Pfadparameter

audience_idstringerforderlich

Die ID der Kontaktliste (aud_…) oder ihr Name.

idstringerforderlich

Die ID des Abonnenten (sub_…) oder die E-Mail-Adresse des Kontakts, URL-kodiert.

Body-Parameter

subscribedboolean

false meldet den Kontakt von dieser Kontaktliste ab, true meldet ihn erneut an. Der Abonnent bleibt in beiden Fällen in der Kontaktliste.

emailstring

Eine neue E-Mail-Adresse für den Kontakt. Wird in Kleinbuchstaben gespeichert.

first_namestring

Der Vorname des Kontakts.

last_namestring

Der Nachname des Kontakts.

custom_fieldsobject

Werte eigener Felder nach Schlüssel. Ersetzt die bestehenden eigenen Felder des Kontakts.

Rückgabe

Gibt das aktualisierte Abonnenten-Objekt zurück. Eine Anfrage ohne eines dieser Felder gibt 400 zurück.

POST/audiences/{audience_id}/subscribers/{id}

JavaScript

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

const subscriber = await emailit.subscribers.update('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo', {
  first_name: 'Augusta',
});

Python

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

subscriber = client.subscribers.update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo", {
  "first_name": "Augusta",
})

PHP

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

$subscriber = $emailit->subscribers()->update('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo', [
  'first_name' => 'Augusta',
]);

Ruby

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

subscriber = client.subscribers.update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  first_name: "Augusta"
)

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

subscriber, err := client.Subscribers.Update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo", &emailit.UpdateSubscriberRequest{
  FirstName: "Augusta",
})

Rust

use emailit::Emailit;
use emailit::types::UpdateSubscriberParams;

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

let subscriber = emailit.subscribers.update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo", UpdateSubscriberParams {
  first_name: Some("Augusta".into()),
  ..Default::default()
}).await?;

Java

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

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject subscriber = emailit.subscribers().update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  SubscriberUpdateParams.builder()
    .setFirstName("Augusta")
    .build()
);

using Emailit;

var emailit = new EmailitClient("your_api_key");

var subscriber = emailit.Subscribers.Update("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo", new SubscriberUpdateOptions {
  FirstName = "Augusta",
});

PHP

use Emailit\Laravel\Facades\Emailit;

$subscriber = Emailit::subscribers()->update('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo', [
  'first_name' => 'Augusta',
]);

Terminal

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

Terminal

curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers/ada%40example.com \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subscribed": false}'

JSON

{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields": {
    "company": "Analytical Engines"
  },
  "subscribed": false,
  "subscribed_at": "2026-10-01T10:20:31.000000Z",
  "unsubscribed_at": "2026-10-02T08:14:55.000000Z",
  "created_at": "2026-10-01T10:20:31.000000Z",
  "updated_at": "2026-10-02T08:14:55.000000Z"
}

JSON

{
  "error": "No valid fields provided for update. Provide at least one of: email, first_name, last_name, custom_fields, subscribed"
}

JSON

{
  "error": "Subscriber not found"
}

Abonnenten auflisten

Gibt eine Seite mit Abonnenten einer Kontaktliste zurück, die neuesten zuerst.

GET/audiences/{audience_id}/subscribers

Erfordert einen API-Schlüssel mit dem Scope full. Die Liste enthält auch Kontakte, die sich von der Kontaktliste abgemeldet haben, sofern Sie sie nicht mit subscribed=true herausfiltern.

Pfadparameter

audience_idstringerforderlich

Die ID der Kontaktliste (aud_…) oder ihr Name.

Query-Parameter

pageintegerStandardwert: 1

Die abzurufende Seite.

limitintegerStandardwert: 25

Abonnenten pro Seite, von 1 bis 100. per_page funktioniert ebenfalls.

subscribedstring

true nur für angemeldete Kontakte, false nur für abgemeldete.

searchstring

Abgleich mit E-Mail-Adresse, Vor- oder Nachname, ohne Beachtung der Groß-/Kleinschreibung.

matchstringStandardwert: all

all oder or. Wie die Filter unten kombiniert werden.

orderstring

Ein Filterschlüssel, nach dem sortiert wird.

directionstring

asc oder desc.

Filter

Fügen Sie Filter als key.condition=value hinzu, zum Beispiel email.ends_with=@acme.com. Siehe Filtern und Sortieren.

Schlüssel	Typ	Hinweise
`email`	string
`first_name`	string
`last_name`	string
`subscribed`	boolean
`created_at`	date	Zeitpunkt, zu dem der Kontakt in die Kontaktliste aufgenommen wurde.

Jeder Schlüssel ist auch ein Sortierschlüssel.

Rückgabe

dataobject[]

Die Abonnenten-Objekte auf dieser Seite.

next_page_urlstring | null

Pfad der nächsten Seite oder null. Er übernimmt subscribed, aber nicht Ihre anderen Filter. Siehe Paginierung.

previous_page_urlstring | null

Pfad der vorherigen Seite oder null.

usageobject

used (Abonnenten in der Kontaktliste), limit (das Maximum, das Ihr Tarif pro Kontaktliste erlaubt, oder null) und plan.

GET/audiences/{audience_id}/subscribers

JavaScript

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

const subscribers = await emailit.subscribers.list('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2');

Python

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

subscribers = client.subscribers.list("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2")

PHP

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

$subscribers = $emailit->subscribers()->list('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2');

Ruby

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

subscribers = client.subscribers.list("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2")

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

subscribers, err := client.Subscribers.List("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", nil)

Rust

use emailit::Emailit;

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

let subscribers = emailit.subscribers.list("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", None).await?;

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject subscribers = emailit.subscribers().list("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2");

using Emailit;

var emailit = new EmailitClient("your_api_key");

var subscribers = emailit.Subscribers.List("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2");

PHP

use Emailit\Laravel\Facades\Emailit;

$subscribers = Emailit::subscribers()->list('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2');

Terminal

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

Terminal

curl -G https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -d subscribed=true \
  -d limit=100

JSON

{
  "data": [
    {
      "object": "subscriber",
      "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
      "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      },
      "subscribed": true,
      "subscribed_at": "2026-10-01T10:20:31.000000Z",
      "unsubscribed_at": null,
      "created_at": "2026-10-01T10:20:31.000000Z",
      "updated_at": "2026-10-01T10:20:31.000000Z"
    },
    {
      "object": "subscriber",
      "id": "sub_4KnmYprkoMRytdkm3tAHIfPW0Vh",
      "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "contact_id": "con_4KiXIs4xLTcJIAHnKJaLcnMZYh7",
      "email": "grace@example.com",
      "first_name": "Grace",
      "last_name": "Hopper",
      "custom_fields": null,
      "subscribed": false,
      "subscribed_at": "2026-09-28T07:55:02.000000Z",
      "unsubscribed_at": "2026-09-30T18:11:40.000000Z",
      "created_at": "2026-09-28T07:55:02.000000Z",
      "updated_at": "2026-09-30T18:11:40.000000Z"
    }
  ],
  "next_page_url": null,
  "previous_page_url": null,
  "usage": {
    "used": 2,
    "limit": 50000,
    "plan": "pro"
  }
}

JSON

{
  "error": "Audience not found"
}

Abonnent löschen

Entfernt einen Kontakt aus einer Kontaktliste.

DELETE/audiences/{audience_id}/subscribers/{id}

Erfordert einen API-Schlüssel mit dem Scope full. Der Kontakt selbst wird nicht gelöscht und bleibt in seinen anderen Kontaktlisten. Um festzuhalten, dass sich jemand abgemeldet hat, melden Sie die Person stattdessen mit subscribed: false ab. Löst das Event subscriber.deleted aus.

Pfadparameter

audience_idstringerforderlich

Die ID der Kontaktliste (aud_…) oder ihr Name.

idstringerforderlich

Die ID des Abonnenten (sub_…) oder die E-Mail-Adresse des Kontakts, URL-kodiert.

Rückgabe

objectstring

Immer subscriber.

idstring

Die ID des gelöschten Abonnenten.

audience_idstring

Die ID der Kontaktliste.

contact_idstring

Die ID des Kontakts.

emailstring

Die E-Mail-Adresse des Kontakts.

deletedboolean

Immer true.

DELETE/audiences/{audience_id}/subscribers/{id}

JavaScript

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

await emailit.subscribers.delete('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo');

Python

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

client.subscribers.delete("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo")

PHP

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

$emailit->subscribers()->delete('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo');

Ruby

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

client.subscribers.delete("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo")

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

err := client.Subscribers.Delete("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo")

Rust

use emailit::Emailit;

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

emailit.subscribers.delete("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo").await?;

Java

import com.emailit.*;

EmailitClient emailit = new EmailitClient("your_api_key");

emailit.subscribers().delete("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo");

using Emailit;

var emailit = new EmailitClient("your_api_key");

emailit.Subscribers.Delete("aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2", "sub_4KECYl5AwXEy8ezswYRhuddttxo");

PHP

use Emailit\Laravel\Facades\Emailit;

Emailit::subscribers()->delete('aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2', 'sub_4KECYl5AwXEy8ezswYRhuddttxo');

Terminal

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

JSON

{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "deleted": true
}

JSON

{
  "error": "Subscriber not found"
}