Tag-Verwaltung

Aufrufadresse

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.

Tag erstellen

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags

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
tag_name	string	ja	Tag-Name, bis zu 64 Zeichen, bestehend aus a-z, A-Z, 0-9, _, chinesischen Zeichen usw.

Request-Beispiel

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{ "name": "myCustomTag" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
  "name": "myCustomTag"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortbeispiel

Antwort-Erfolg

HttpStatus: 200

{ "result":{ "tag_id": "62732d3ddd017d22ccd118e4", "tag_name": "education", "create_time": "2023-11-28T11:14:48+0800", "update_time": "2023-11-28T11:14:48+0800" } }

              
              {
    "result":{
      "tag_id": "62732d3ddd017d22ccd118e4",
      "tag_name": "education",
      "create_time": "2023-11-28T11:14:48+0800",
      "update_time": "2023-11-28T11:14:48+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tag löschen

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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)

Request-Beispiel

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortbeispiel

Antwort-Erfolg

HttpStatus: 200

{ "count": 1 }

              
              {
   "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

{ "code": 30036, "message": "resource not found" }

              
              {
    "code": 30036,
    "message": "resource not found"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tag aktualisieren

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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
tag_name	string	nein	Tag-Name, bis zu 64 Zeichen, bestehend aus a-z, A-Z, 0-9, _, chinesischen Zeichen usw.

Request-Beispiel

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{ "name": "myCustomTag" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{
  "name": "myCustomTag"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortbeispiel

Antwort-Erfolg

HttpStatus: 200

{ "count": 1 }

              
              {
   "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HttpStatus: 400

{ "code": 30035, "message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters" }

              
              {
    "code": 30035,
    "message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tag-Liste abrufen

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags

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)

Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
tag_name	string	nein	Tag-Name abfragen (unterstützt unscharfe Suche)
offset	integer	nein	Startposition der Abfrage, Wertebereich [0-], Standard 0
limit	integer	nein	Anzahl der Abfragen, Wertebereich [1-100], Standard 10

Request-Beispiel

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Parameter

Parameter	Typ	Beschreibung
result	array[object]	Tag-Liste
tag_id	string	Tag-ID
tag_name	string	Tag-Name
create_time	string	Erstellungszeit
update_time	string	Aktualisierungszeit
count	integer	Anzahl der Mitglieder mit diesem Tag
total	integer	Gesamtanzahl der Datensätze
count	integer	Anzahl der zurückgegebenen Datensätze

Antwortbeispiel

Antwort-Erfolg

HttpStatus: 200

{ "result": [ { "tag_id": "617a71ac672b2823a1a82c13", "tag_name": "education", "create_time": "2023-11-28T11:14:48+0800", "update_time":"2023-11-28T11:14:48+0800", "count": 1 } ], "count": 1, "total": 1 }

              
              {
  "result": [
    {
      "tag_id": "617a71ac672b2823a1a82c13",
      "tag_name": "education",
      "create_time": "2023-11-28T11:14:48+0800",
      "update_time":"2023-11-28T11:14:48+0800",
      "count": 1
    }
  ],
  "count": 1,
  "total": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tags Mitgliedern zuweisen

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add

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
member_ids	string[]	ja	Liste der Mitglieds-IDs, maximal 1.000 IDs auf einmal

Request-Beispiel

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f/add --data '{
  "member_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortbeispiel

Antwort-Erfolg

HttpStatus: 200

{ "count": 2 }

              
              {
 "count": 2
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Tags von Mitgliedern entfernen

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove

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	Bearer Token

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
member_ids	array[string]	ja	Liste der Mitglieds-IDs, maximal 1.000 IDs auf einmal

Request-Beispiel

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/remove --data '{ "memberIds": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/remove --data '{
  "memberIds": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortbeispiel

Antwort-Erfolg

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Mitglieder eines Tags abrufen

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/members

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/members

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	Bearer Token

Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
offset	integer	nein	Startposition der Abfrage, Wertebereich [0-], Standard 0
limit	integer	nein	Anzahl der Abfragen, Wertebereich [1-100], Standard 10

Request-Beispiel

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Parameter

Parameter	Typ	Beschreibung
result	object	Mitgliederliste
member_id	string	Mitglieds-ID
list_id	integer	Listen-ID
email	string	E-Mail-Adresse
phone	string	Telefonnummer
name	string	Name
create_time	string	Erstellungszeit (UTC+8)
update_time	string	Aktualisierungszeit (UTC+8)
unsubscribe_time	string	Abmeldezeitpunkt (UTC+8)
fields	object	Mitgliederfelder
tag_ids	array[string]	Tag-ID-Set
tag_names	array[string]	Tag-Namen-Set
total	integer	Gesamtanzahl der passenden Datensätze

Antwortbeispiel

Antwort-Erfolg

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": [ "646f28a7cac6587565ad6918" ], "tag_names": [ "test" ], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T16:42:11+0800", "unsubscribe_time": null } ], "total": 2, "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": [
                "646f28a7cac6587565ad6918"
            ],
            "tag_names": [
                "test"
            ],
            "create_time": "2023-11-28T18:30:02+0800",
            "update_time": "2023-11-30T16:42:11+0800",
            "unsubscribe_time": null
        }
    ],
    "total": 2,
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Diesen Codeblock im schwebenden Fenster anzeigen