Email Label

Labels ermöglichen zusätzliche Statistiken zu E-Mails.

Über die API können Sie Labels abfragen, hinzufügen, löschen und bearbeiten.

API-Endpunkte

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

Stellen Sie bei der Nutzung der REST API sicher, dass das ausgewählte Rechenzentrum zur entsprechenden Basis-URL passt.

POST/v1/labels

Batch-Abfrage

Liste der zurückgegebenen Labels

URL

https://email.api.engagelab.cc/v1/labels

              
              https://email.api.engagelab.cc/v1/labels

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Beschreibung der Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
offset	int	nein	Startposition, [0-], Standardwert: 0
limit	int	nein	Anzahl, [0-100], Standardwert: 100
label_name	string	nein	Unscharfe Suche

Beispiel für eine Anfrage

curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
label_id	Label-ID
label_name	Label-Name
create_time	Erstellungszeitpunkt des Labels
update_time	Zeitpunkt der letzten Änderung des Labels

Beispiel für Rückgabewerte

Erfolgreiche Antwort

HTTP Status: 200

{ "total": 28, "count": 28, "result": [ { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } ] }

              
              {
    "total": 28,
    "count": 28,
    "result": [
        {
            "label_id": 598802,
            "label_name": "xjm226",
            "create_time": "2022-11-14T14:27:48+0800",
            "update_time": "2022-11-14T14:27:48+0800"
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerhafte Antwort

HTTP Status: 401

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Einzelne Abfrage

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Beispiel für eine Anfrage

curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
label_id	Label-ID
label_name	Label-Name
create_time	Erstellungszeitpunkt des Labels
update_time	Zeitpunkt der letzten Änderung des Labels

Beispiel für Rückgabewerte

Erfolgreiche Antwort

HTTP Status: 200

{ "result": { "label_id": 598100, "label_name": "xiaoxiao", "create_time": "2022-08-09T13:49:46+0800", "update_time": "2022-11-12T14:12:12+0800" } }

              
              {
    "result": {
        "label_id": 598100,
        "label_name": "xiaoxiao",
        "create_time": "2022-08-09T13:49:46+0800",
        "update_time": "2022-11-12T14:12:12+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerhafte Antwort

HTTP Status: 401

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Hinzufügen

URL

https://email.api.engagelab.cc/v1/labels

              
              https://email.api.engagelab.cc/v1/labels

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Beschreibung der Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
label_name	string	ja	Label-Name, der hinzugefügt werden soll. Maximal 64 Zeichen.

Hinweis:
Die maximale Anzahl an Labels beträgt 100.000

Beispiel für eine Anfrage

curl -X POST "https://email.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name":"hongkong" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/labels" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "label_name":"hongkong"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
label_id	Label-ID
label_name	Label-Name
create_time	Erstellungszeitpunkt des Labels
update_time	Zeitpunkt der letzten Änderung des Labels

Beispiel für Rückgabewerte

Erfolgreiche Antwort

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }

              
              {
    "result": {
        "label_id": 598802,
        "label_name": "xjm226",
        "create_time": "2022-11-14T14:27:34+0800",
        "update_time": "2022-11-14T14:27:34+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerhafte Antwort

HTTP Status: 400

{ "code": 30105, "message": "The label name should be 1-255 characters" }

              
              {
    "code": 30105,
    "message": "The label name should be 1-255 characters"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Löschen

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Beispiel für eine Anfrage

curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
count	Anzahl der gelöschten Labels

Beispiel für Rückgabewerte

Erfolgreiche Antwort

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerhafte Antwort

HTTP Status: 401

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Bearbeiten

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

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

Beschreibung der Parameter

Parameter	Typ	Erforderlich	Beschreibung
label_name	string	ja	Neuer Label-Name. Maximal 64 Zeichen.

Beispiel für eine Anfrage

curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name":"travel" }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "label_name":"travel"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
count	Anzahl der bearbeiteten Labels

Beispiel für Rückgabewerte

Erfolgreiche Antwort

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerhafte Antwort

HTTP Status: 401

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

E-Mail-Label

API-Endpunkte

Batch-Abfrage

Einzelne Abfrage

Hinzufügen

Löschen

Bearbeiten