Unsubscribe-API: E-Mail-Abmeldungen zentral verwalten
Die Unsubscribe-API ermöglicht die zentrale Verwaltung von E-Mail-Abmeldungen über eine sichere REST-Schnittstelle. Mit dieser API können Sie E-Mail-Adressen, die sich von Ihrem Verteiler abgemeldet haben, effizient abfragen, hinzufügen oder löschen. So stellen Sie sicher, dass keine weiteren E-Mails an abgemeldete Adressen gesendet werden und Ihre E-Mail-Kommunikation DSGVO-konform bleibt.
Aufrufadresse
| Rechenzentrum | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Achten Sie bei der Nutzung der REST API darauf, das passende Rechenzentrum und die entsprechende Basis-URL zu verwenden.
POST/v1/unsubscribes
Abfrage von E-Mail-Abmeldungen
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| start_date | string | * | Startdatum (Format: yyyy-MM-dd) |
| end_date | string | * | Enddatum (Format: yyyy-MM-dd) |
| string | * | E-Mail-Adresse, z. B. 22@gmail.com |
|
| api_user | string | nein | Angegebener API_USER, Standardwert ist all |
| offset | int | nein | Startposition [0-], Standardwert ist 0 |
| limit | int | nein | Anzahl [0-100], Standardwert ist 100 |
Hinweise:
- Der Abfragezeitraum darf maximal 3 Monate betragen.
- Bei der Suche nach einer bestimmten E-Mail-Adresse wird der Zeitraum ignoriert.
Beispiel für eine Anfrage:
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| E-Mail-Adresse | |
| api_user | API_USER |
| type | Art der Abmeldung (0, 1, 2, 3) |
| unsubscribe_time | Zeitpunkt der Abmeldung |
| expire_time | Ablaufzeitpunkt der Unsubscribe-Sperre |
| Typ | Beschreibung |
|---|---|
| 0 | Ich möchte solche E-Mails nicht mehr erhalten |
| 1 | Ich habe mich dafür nicht angemeldet |
| 2 | Dies ist eine Spam-E-Mail |
| 3 | Dies ist eine Betrugs-E-Mail, ich möchte sie melden |
Beispiel für Rückgabewerte:
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
E-Mail-Adresse zur Unsubscribe-Liste hinzufügen
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type:
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
POST
POST
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | ja | Hinzuzufügende E-Mail-Adresse | |
| expire_time | string | ja | Ablaufzeitpunkt der Unsubscribe-Sperre (Format: yyyy-MM-dd) |
Beispiel für eine Anfrage:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}' \
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}' \
'https://email.api.engagelab.cc/v1/unsubscribes'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| E-Mail-Adresse | |
| api_user | API_USER |
| unsubscribe_time | Zeitpunkt der Abmeldung |
| expire_time | Ablaufzeitpunkt |
Beispiel für Rückgabewerte:
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
E-Mail-Adresse aus der Unsubscribe-Liste löschen
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
DELETE
DELETE
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | * | Zu löschende E-Mail-Adresse(n) | |
| start_date | string | * | Startdatum (Format: yyyy-MM-dd) |
| end_date | string | * | Enddatum (Format: yyyy-MM-dd) |
Beispiel für eine Anfrage
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}' \
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}' \
'https://email.api.engagelab.cc/v1/unsubscribes'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| count | Anzahl der gelöschten Adressen |
Beispiel für Rückgabewerte:
Antwort – Erfolg
HTTP-Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort – Fehler
HTTP-Status: 401
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen."
}
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Mit der Unsubscribe-API von EngageLab behalten Sie die Kontrolle über Ihre E-Mail-Abmeldungen und sorgen für eine zuverlässige E-Mail-Blockierung. Nutzen Sie diese REST API, um Ihre E-Mail-Verwaltung effizient und datenschutzkonform zu gestalten.
Jetzt mehr erfahren!
