Mitgliederverwaltung API – Dokumentation für E-Mail Marketing
API-Endpunkte
| Rechenzentrum | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Beim Einsatz der REST API ist sicherzustellen, dass das gewählte Rechenzentrum zur entsprechenden Basis-URL passt.
Stapelweise (Batch) Hinzufügen oder Aktualisieren von Mitgliedern
URL
https://email.api.engagelab.cc/v1/marketing/lists/members
https://email.api.engagelab.cc/v1/marketing/lists/members
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
POST
POST
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(api_user:api_key) |
Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| members | array[object] | ja | Liste der Mitglieder, maximal 1.000 Einträge |
| string | ja | E-Mail-Adresse | |
| phone | string | nein | Telefonnummer |
| name | string | nein | Spitzname |
| fields | object | nein | Kontaktfelder |
| tags | string[] | nein | Liste der Tag-Namen |
| tag_flag | integer | nein | Tag-Update-Methode: 0 = überschreiben, 1 = anhängen, 2 = überspringen (Standard: 1) |
| update_existing | boolean | ja | Eigenschaften aktualisieren, falls Adresse bereits existiert |
Hinweise:
- Ist das E-Mail-Feld eines Mitglieds identisch mit dem Wert von members.email, wird das Mitglied aktualisiert. Andernfalls wird ein neues Mitglied hinzugefügt.
- Unterschiedliche Werte von tag_flag führen zu verschiedenen Arten der Tag-Aktualisierung. Siehe Beispiele unten:
| tag_flag | Ursprüngliche Tags | Parameter-Tags | Neue Tags |
|---|---|---|---|
| 0 | [1,2,3] | [] | [] |
| 0 | [1,2,3] | null, kein Wert | [1,2,3] |
| 0 | [1,2,3] | [3,4,5] | [3,4,5] |
| 1 | [1,2,3] | [] | [1,2,3] |
| 1 | [1,2,3] | null, kein Wert | [1,2,3] |
| 1 | [1,2,3] | [3,4,5] | [1,2,3,4,5] |
| 2 | [1,2,3] | [] | [1,2,3] |
| 2 | [1,2,3] | null, kein Wert | [1,2,3] |
| 2 | [1,2,3] | [3,4,5] | [1,2,3] |
| 2 | [] | [3,4,5] | [] |
Beispiel-Request
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
-i https://email.api.engagelab.cc/v1/marketing/lists/members \
--data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
-i https://email.api.engagelab.cc/v1/marketing/lists/members \
--data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beispiel-Antwort
Erfolgreiche Antwort
HttpStatus: 200
{
"created_count": 2,
"created_members": [{
"email": "202205ab233444444444446@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b0c"
},{
"email": "202205ab3331@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b0d"
}],
"updated_count": 2,
"updated_members": [{
"email": "202205ab233444444444447@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b1c"
},{
"email": "202205ab3332@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b1d"
}],
"error_count": 2,
"error_members": [{
"email": "202205ab233444444444446@qq.com",
"message": "..."
},{
"email": "202205ab3331@qq.com",
"message": "..."
}]
}
{
"created_count": 2,
"created_members": [{
"email": "202205ab233444444444446@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b0c"
},{
"email": "202205ab3331@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b0d"
}],
"updated_count": 2,
"updated_members": [{
"email": "202205ab233444444444447@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b1c"
},{
"email": "202205ab3332@qq.com",
"member_id": "6294b0fa490f33c5ee3b5b1d"
}],
"error_count": 2,
"error_members": [{
"email": "202205ab233444444444446@qq.com",
"message": "..."
},{
"email": "202205ab3331@qq.com",
"message": "..."
}]
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehler-Antwort
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Löschen eines Mitglieds
URL
https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}
https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
DELETE
DELETE
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(api_user:api_key) |
Beispiel-Request
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8
Diesen Codeblock im schwebenden Fenster anzeigen
Beispiel-Antwort
Erfolgreiche Antwort
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehler-Antwort
HttpStatus: 401
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Stapelweises Löschen (Batch Delete)
URL
https://email.api.engagelab.cc/v1/marketing/lists/members/delete
https://email.api.engagelab.cc/v1/marketing/lists/members/delete
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
DELETE
DELETE
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(api_user:api_key) |
Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| condition | object | nein | Abfragebedingung |
| relation | string | ja | Verknüpfung der Bedingungen (and oder or) |
| items | object[] | ja | Filterbedingungen: Unterstützt bis zu 10 Bedingungen. Alle Bedingungen müssen dieselbe Relation haben („and“ oder „or“) |
| field_name | string | ja | field_name steht für den Attributnamen, value für den Feldwert. Wenn field_name tag ist, dann value = Tag-Name |
| op | string | ja | Operator (==, !=, >, >=, <, <=, exist, contain, does not contain) |
| value | string | ja | Bei field_name tag: value = Tag-Name Bei Attributnamen siehe Filterbedingungen |
Hinweis:
Die Beziehung zwischen field_name und op finden Sie unter Filterbedingungen.
Beispiel-Request
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data '
{
"condition": {
"relation": "or",
"items": [
{
"field_name": "Email",
"op": "contain",
"value": "hotmail.com"
},
{
"field_name": "Phone",
"op": "contain",
"value": "188"
}
]
}
}
'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data '
{
"condition": {
"relation": "or",
"items": [
{
"field_name": "Email",
"op": "contain",
"value": "hotmail.com"
},
{
"field_name": "Phone",
"op": "contain",
"value": "188"
}
]
}
}
'
Diesen Codeblock im schwebenden Fenster anzeigen
Beispiel-Antwort
Erfolgreiche Antwort
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehler-Antwort
HttpStatus: 401
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Aktualisieren eines Mitglieds
URL
https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}
https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
PUT
PUT
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(api_user:api_key) |
Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| phone | string | nein | Telefonnummer |
| name | string | nein | Spitzname |
| fields | object | nein | Mitgliederfelder |
| tags | string[] | nein | Liste der Tag-Namen |
Beispiel-Request
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i \
https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 \
--data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i \
https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 \
--data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| member_id | string | Mitglieder-ID |
| list_id | integer | Listen-ID |
| user_id | integer | Benutzer-ID |
| string | E-Mail-Adresse | |
| phone | string | Telefonnummer |
| name | string | Name |
| create_time | string | Erstellzeitpunkt (UTC+8) |
| update_time | string | Aktualisierungszeitpunkt (UTC+8) |
| unsubscribe_time | string | Abmeldezeitpunkt (UTC+8) |
| fields | object | Mitgliederfelder |
| tags | string[] | Tag-ID-Set |
| tag_names | string[] | Tag-Namen-Set |
Beispiel-Antwort
Erfolgreiche Antwort
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehler-Antwort
HttpStatus: 200
{
"code": 30036,
"message": "Ressource nicht gefunden"
}
{
"code": 30036,
"message": "Ressource nicht gefunden"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Mitgliederdetails abrufen
URL
https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}
https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(api_user:api_key) |
Beispiel-Request
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| member_id | string | Mitglieder-ID |
| list_id | integer | Listen-ID |
| string | E-Mail-Adresse | |
| phone | string | Telefonnummer |
| name | string | Name |
| create_time | string | Erstellzeitpunkt (UTC+8) |
| update_time | string | Aktualisierungszeitpunkt (UTC+8) |
| unsubscribe_time | string | Abmeldezeitpunkt (UTC+8) |
| fields | object | Kontakt-Eigenschaften |
| tag_ids | string[] | Tag-ID-Set |
| tag_names | string[] | Tag-Namen-Set |
Erfolgreiche Antwort
HttpStatus: 200
{
"result": {
"member_id": "6565c12a3b4e0d83d3f58ea0",
"list_id": 95964,
"email": "xjmfc@126.com",
"phone": null,
"name": null,
"fields": {
"Birthday": "03/30",
"Age": "12"
},
"tag_ids": [],
"tag_names": [],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T16:44:44+0800",
"unsubscribe_time": null
}
}
{
"result": {
"member_id": "6565c12a3b4e0d83d3f58ea0",
"list_id": 95964,
"email": "xjmfc@126.com",
"phone": null,
"name": null,
"fields": {
"Birthday": "03/30",
"Age": "12"
},
"tag_ids": [],
"tag_names": [],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T16:44:44+0800",
"unsubscribe_time": null
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehler-Antwort
HttpStatus: 401
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Mitgliederliste (Abonnentenliste) abrufen
URL
https://email.api.engagelab.cc/v1/marketing/lists/list_members
https://email.api.engagelab.cc/v1/marketing/lists/list_members
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
POST
POST
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Headers
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(api_user:api_key) |
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| limit | integer | nein | Anzahl der abzurufenden Einträge, Bereich [1-100], Standard: 10 |
| offset | integer | nein | Startposition der Abfrage, Bereich [0-], Standard: 0 |
Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| condition | object | nein | Abfragebedingung |
| relation | string | ja | Verknüpfung der Bedingungen (and oder or) |
| items | object[] | ja | Filterbedingungen. Bis zu 10 Bedingungen, alle mit derselben Relation („and“ oder „or“) |
| field_name | string | ja | field_name steht für den Feldnamen, value für den Feldwert; Wenn field_name tag ist, dann value=Tag-Name |
| op | string | ja | Operator (==, !=, >, >=, <, <=, exist, contain, does not contain) |
| value | string | ja | Bei field_name tag: value=Tag-Name Bei Feldnamen siehe Filterbedingungen |
Hinweis:
Die Beziehung zwischen field_name und op finden Sie unter Filterbedingungen.
Beispiel-Request
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{
"condition": {
"relation": "and",
"items": [
{
"field_name": "Email",
"op": "contain",
"value": "qq.com"
}
]
}
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{
"condition": {
"relation": "and",
"items": [
{
"field_name": "Email",
"op": "contain",
"value": "qq.com"
}
]
}
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Antwort-Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| list | array | Listen-Array |
| member_id | string | Mitglieder-ID |
| list_id | integer | Listen-ID |
| string | E-Mail-Adresse | |
| phone | string | Telefonnummer |
| name | string | Name |
| create_time | string | Erstellzeitpunkt (UTC+8) |
| update_time | string | Aktualisierungszeitpunkt (UTC+8) |
| unsubscribe_time | string | Abmeldezeitpunkt (UTC+8) |
| fields | object | Mitglieder-Eigenschaften |
| tag_ids | string[] | Tag-ID-Set |
| tag_names | string[] | Tag-Namen-Set |
| total | integer | Gesamtanzahl der Einträge |
Beispiel-Antwort
Erfolgreiche Antwort
HttpStatus: 200
{
"result": [
{
"member_id": "6565c12a3b4e0d83d3f58ea0",
"list_id": 95964,
"email": "xjmfc@126.com",
"phone": null,
"name": null,
"fields": {
"Birthday": "03/30",
"Age": "12"
},
"tag_ids": [],
"tag_names": [],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T17:00:19+0800",
"unsubscribe_time": null
}
],
"total": 3,
"count": 1
}
{
"result": [
{
"member_id": "6565c12a3b4e0d83d3f58ea0",
"list_id": 95964,
"email": "xjmfc@126.com",
"phone": null,
"name": null,
"fields": {
"Birthday": "03/30",
"Age": "12"
},
"tag_ids": [],
"tag_names": [],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T17:00:19+0800",
"unsubscribe_time": null
}
],
"total": 3,
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehler-Antwort
HttpStatus: 401
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
{
"code": 30000,
"message": "Authentifizierung fehlgeschlagen"
}
Diesen Codeblock im schwebenden Fenster anzeigen
SEO-Hinweis:
Diese Dokumentation zur Mitgliederverwaltung API für E-Mail Marketing enthält alle relevanten Informationen zu den Themen „API Dokumentation“, „Mitgliederverwaltung“ und „E-Mail Marketing“.
