logoDokumentation
E-Mail
Doku-Startseite
SchnellstartAnweisungenREST APISMTPUseMarketingWebHookResources
Suchen
Deutsch
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Bahasa Indonesia
Deutsch
Français
Anmelden
REST API / Address List

Adresslisten

Zuletzt aktualisiert：almost 3 years ago

Adresslisten werden typischerweise für den Versand von Marketing-E-Mails genutzt und sind ein zentrales Element der Adressverwaltung im E-Mail-Marketing. Sie können Adresslisten abfragen, hinzufügen, bearbeiten und löschen sowie die Mitglieder verwalten.

Adresslisten aufrufen

Rechenzentrum URL
Singapur https://email.api.engagelab.cc
Türkei https://emailapi-tr.engagelab.com

Achten Sie bei der Verwendung der REST API darauf, dass das ausgewählte Rechenzentrum zur entsprechenden Basis-URL passt.

POST /v1/address_lists

Adresslisten stapelweise abfragen

URL

https://email.api.engagelab.cc/v1/address_lists
              
              https://email.api.engagelab.cc/v1/address_lists
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET
              
              GET
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Query-Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
offset int nein Offset-Position (ab 0), Standardwert: 0
limit int nein Anzahl (0-100), Standardwert: 100
name string nein Name der Adressliste
address string nein Adresse der Adressliste

Beispiel-Anfrage

curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
              
              curl  'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter Beschreibung
address_list_id ID der Liste
name Name der Adressliste
address Alias-Adresse der Liste, Operationen können über die Alias-Adresse aufgerufen werden; Format: xxx@maillist.email.engagelab.com
member_count Anzahl der Adressen in der Liste
desc Beschreibung der Adressliste
create_time Erstellungszeitpunkt der Adressliste
update_time Zeitpunkt der letzten Änderung der Adressliste

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "result": [ { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "Description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } ], "total": 1, "count": 1 }
              
              {
  "result": [
    {
      "address_list_id": 65499,
      "address": "jg2@maillist.email.engagelab.com",
      "name": "1113-mailist",
      "member_count": 2,
      "Description": "desc222ss",
      "create_time": "2022-11-12T16:46:12+0800",
      "update_time": "2022-11-12T16:50:01+0800"
    }
  ],
  "total": 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

Einzelne Adressliste abfragen

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET
              
              GET
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Beispiel-Anfrage

curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter Beschreibung
address_list_id ID der Adressliste
name Name der Liste
address Alias-Adresse, über die Operationen aufgerufen werden können, Format: xxx@maillist.email.engagelab.com
member_count Anzahl der Adressen in der Liste
desc Beschreibung der Adressliste
create_time Erstellungszeitpunkt der Adressliste
update_time Zeitpunkt der letzten Änderung der Adressliste

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "result": { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "Description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } }
              
              {
  "result":
    {
      "address_list_id": 65499,
      "address": "jg2@maillist.email.engagelab.com",
      "name": "1113-mailist",
      "member_count": 2,
      "Description": "desc222ss",
      "create_time": "2022-11-12T16:46:12+0800",
      "update_time": "2022-11-12T16:50:01+0800"
    }
}
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

Adressliste hinzufügen

URL

https://email.api.engagelab.cc/v1/address_lists
              
              https://email.api.engagelab.cc/v1/address_lists
Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type:
Content-Type: application/json;charset=utf-8

HTTP-Anfragemethode

POST
              
              POST
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Body-Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
name string ja Name der Liste. Maximal 48 Zeichen.
address string ja Beispiel: marketing@maillist.email.engagelab.com
desc string nein Beschreibung der Liste

Beispiel-Anfrage

curl -X POST "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"scgd@email.engagelab.com", "name":"hongKong", "desc":"" }'
              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"scgd@email.engagelab.com",
"name":"hongKong",
"desc":""
}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter Beschreibung
address_list_id ID der Liste
address Adresse der Liste
member_count Anzahl der Mitglieder in der Liste
name Name der Liste
desc Beschreibung der Adressliste
create_time Erstellungszeitpunkt der Adressliste
update_time Zeitpunkt der letzten Änderung

Beispiel-Rückgabe

Antwort-Erfolg

{ "result": { "address_list_id": 65504, "address": "jg3@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 0, "desc": "desc", "create_time": "2022-11-15T16:25:02+0800", "update_time": "2022-11-15T16:25:02+0800" } }
              
              {
  "result": {
    "address_list_id": 65504,
    "address": "jg3@maillist.email.engagelab.com",
    "name": "1113-mailist",
    "member_count": 0,
    "desc": "desc",
    "create_time": "2022-11-15T16:25:02+0800",
    "update_time": "2022-11-15T16:25:02+0800"
  }
}
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Adressliste löschen

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

DELETE
              
              DELETE
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Beispiel-Anfrage

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter Beschreibung
count Anzahl der gelöschten Listen

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }
              
              {
  "count": 1   
}
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Adressliste bearbeiten

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type:
Content-Type: application/json;charset=utf-8

HTTP-Anfragemethode

PUT
              
              PUT
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
address string nein Beispiel: marketing@maillist.email.engagelab.com
name string nein Name der zu bearbeitenden Liste
desc string nein Beschreibung der zu bearbeitenden Liste

Hinweis:
„name“ oder „desc“ können einzeln oder kombiniert geändert werden.

Beispiel-Anfrage

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"new@maillist.email.engagelab.com", "name":"GZ", "desc":"2" }'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"new@maillist.email.engagelab.com",
"name":"GZ",
"desc":"2"
}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Antwort-Erfolg

HTTP-Status: 200

Parameter Beschreibung
count Anzahl der bearbeiteten Listen

Beispiel-Rückgabe

{ "count": 1 }
              
              { 
  "count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglieder abfragen

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET
              
              GET
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Query-Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
offset int nein Offset-Position (ab 0), Standardwert: 0
limit int nein Anzahl (0-100), Standardwert: 100
email string nein E-Mail-Adresse des Mitglieds suchen. Ungefähre Suche wird unterstützt.
member_ids string nein Mehrere Mitglieder-IDs, getrennt durch ';'. Maximal 100.

Beispiel-Anfrage

curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter Beschreibung
member_id ID des Mitglieds
email E-Mail-Adresse des Mitglieds
name Name des Mitglieds
vars Variablen
create_time Erstellungszeitpunkt des Mitglieds
update_time Zeitpunkt der letzten Änderung

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "result": [ { "member_id": "11719293", "email": "example2@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-13 11:23:44", "update_time": "2022-11-13 11:23:44" }, { "member_id": "11719294", "email": "example5@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-15 16:34:47", "update_time": "2022-11-15 16:34:47" } ], "total": 2, "count": 2, "address_list_id": "65499" }
              
              {
  "result": [
    {
      "member_id": "11719293",
      "email": "example2@abc.com",
      "name": null,
      "vars": "{\"loc\":\"sss\"}",
      "create_time": "2022-11-13 11:23:44",
      "update_time": "2022-11-13 11:23:44"
    },
    {
      "member_id": "11719294",
      "email": "example5@abc.com",
      "name": null,
      "vars": "{\"loc\":\"sss\"}",
      "create_time": "2022-11-15 16:34:47",
      "update_time": "2022-11-15 16:34:47"
    }
  ],
  "total": 2,
  "count": 2,
  "address_list_id": "65499"
}
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglied hinzufügen

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type:
application/json; charset=utf-8

HTTP-Anfragemethode

POST
              
              POST
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Body-Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
members array[object] ja Liste der Mitglieder. Maximal 1.000 Mitglieder.
email string ja E-Mail-Adresse.
name string nein Name des Mitglieds. Maximal 128 Zeichen.
vars string nein Variablen. Maximal 1 KB.

Hinweise:

  1. Beim Hinzufügen von Variablen (vars) muss der Schlüssel nicht mit '%' markiert werden, und die Schlüssellänge darf 32 Zeichen nicht überschreiten.
  2. In der Variablen vars wird der Schlüssel name durch den Parameter name überschrieben.
  3. Beim Versand an die Adressliste kann die globale Variable recipient verwendet werden, deren Wert die E-Mail-Adresse des Empfängers ist.

Beispiel-Anfrage

curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Feld Beschreibung
count Anzahl der hinzugefügten Mitglieder
invalid Ungültige Mitglieder
invalidCount Anzahl der E-Mail-Adressen, die nicht hinzugefügt werden konnten
reasonList Grund für das Fehlschlagen der E-Mail-Adresse

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "result": { "count": 2, "invalidCount": 1, "invalid": [ "wang.@yahoo.com" ], "reasonList": [ "Member email format erorr" ] } }
              
              {
  "result": {
    "count": 2,
    "invalidCount": 1,
    "invalid": [
      "wang.@yahoo.com"
    ],
    "reasonList": [
      "Member email format erorr"
    ]
  }
}
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglied bearbeiten

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type:
application/json; charset=utf-8

HTTP-Anfragemethode

PUT
              
              PUT
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Body-Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
email string ja E-Mail-Adresse
name string nein Name des Mitglieds. Maximal 128 Zeichen.
vars object nein Variablen. Maximal 1 KB. Die Schlüssellänge darf 32 Zeichen nicht überschreiten.

Beispiel-Anfrage

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"email":"x@engagelab.com","name":"jim"}'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"email":"x@engagelab.com","name":"jim"}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Feld Beschreibung
count Anzahl der bearbeiteten Adressen
reason Grund für das Fehlschlagen der Aktualisierung der E-Mail-Adresse

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "count": 0, "reason": "Member email format erorr" }
              
              {
  "count": 0,
  "reason": "Member email format erorr" 
}
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglied löschen

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

DELETE
              
              DELETE
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

Header Typ Erforderlich Beschreibung
Authorization String ja Basic base64(api_user:api_key)

Query-Parameter-Beschreibung

Parameter Typ Erforderlich Beschreibung
member_ids string ja Mit Strichpunkt (;) getrennte Liste der Mitglieder-IDs. Maximal 100 Mitglieder.

Beispiel-Anfrage

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Feld Beschreibung
count Anzahl der gelöschten Adressen

Beispiel-Rückgabe

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }
              
              { "count": 1 }
Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen." }
              
              { 
    "code": 30000,
    "message": "Authentifizierung fehlgeschlagen."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Mit dieser API-Dokumentation können Sie Adresslisten und deren Mitglieder effizient verwalten und so Ihr E-Mail-Marketing und Ihre Adressverwaltung optimal gestalten.

icon
Vertrieb kontaktieren