E-Mail-Vorlage
Die E-Mail-Vorlage ermöglicht es Entwickler:innen, E-Mails mit ähnlichem Inhalt effizient an verschiedene Kund:innen zu versenden.
Sie können Vorlagen per API abfragen, hinzufügen, löschen und bearbeiten.
Aufrufadresse
| Rechenzentrum | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Beim Einsatz der REST API achten Sie darauf, dass das gewählte Rechenzentrum mit der entsprechenden Basis-URL übereinstimmt.
POST/v1/templates
Abfrage (Batch)
Basisinformationen der zurückgegebenen E-Mail-Vorlage.
URL
https://email.api.engagelab.cc/v1/templates
https://email.api.engagelab.cc/v1/templates
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) |
Beschreibung der Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| offset | int | nein | Offset-Position, [0-], Standardwert 0 |
| limit | int | nein | Anzahl, [0-100], Standardwert 100 |
| name | string | ja | Name der E-Mail-Vorlage |
| template_invoke_name | string | nein | Name der aufgerufenen E-Mail-Vorlage |
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/templates?offset=0&limit=3'
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| template_id | ID der E-Mail-Vorlage |
| name | Name der E-Mail-Vorlage |
| template_invoke_name | Name der aufgerufenen E-Mail-Vorlage |
| html | Inhalt im HTML-Format |
| preview_text | Vorschautext der E-Mail-Vorlage |
| subject | Betreff der E-Mail-Vorlage |
| create_time | Zeitpunkt der Erstellung der Vorlage |
| update_time | Zeitpunkt der letzten Änderung der Vorlage |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{
"result": [{
"template_id": 82522,
"name": "dffddf",
"template_invoke_name": "dffdfd",
"html": null,
"text": null,
"subject": "fdfdfd😅🙂🙂🙂🙂",
"preview_text": "",
"create_time": "2022-11-10 15:47:05",
"update_time": "2022-11-10 15:47:05"
}],
"count":10,
"total":20
}
{
"result": [{
"template_id": 82522,
"name": "dffddf",
"template_invoke_name": "dffdfd",
"html": null,
"text": null,
"subject": "fdfdfd😅🙂🙂🙂🙂",
"preview_text": "",
"create_time": "2022-11-10 15:47:05",
"update_time": "2022-11-10 15:47:05"
}],
"count":10,
"total":20
}
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status: 400
{
"code": 30202,
"message": "Invalid template_invoke_name"
}
{
"code": 30202,
"message": "Invalid template_invoke_name"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Einzelabfrage
Detaillierte Informationen zur zurückgegebenen E-Mail-Vorlage.
URL
https://email.api.engagelab.cc/v1/templates/{template_id}
https://email.api.engagelab.cc/v1/templates/{template_id}
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) |
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/templates/11111111'
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/templates/11111111'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| template_id | ID der E-Mail-Vorlage |
| name | Name der E-Mail-Vorlage |
| template_invoke_name | Name der aufgerufenen E-Mail-Vorlage |
| html | Inhalt im HTML-Format |
| preview_text | Vorschautext der E-Mail-Vorlage |
| subject | Betreff der E-Mail-Vorlage |
| create_time | Zeitpunkt der Erstellung der Vorlage |
| update_time | Zeitpunkt der letzten Änderung der Vorlage |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{
"result":{
"template_id": 76707,
"name": "libo01s",
"template_invoke_name": "libo01d",
"html": "The is first email",
"text": null,
"subject": "happyaaa",
"preview_text": "",
"create_time": "2019-07-22T11:52:45+0800",
"update_time": "2019-08-01T11:29:19+0800"
}
}
{
"result":{
"template_id": 76707,
"name": "libo01s",
"template_invoke_name": "libo01d",
"html": "The is first email",
"text": null,
"subject": "happyaaa",
"preview_text": "",
"create_time": "2019-07-22T11:52:45+0800",
"update_time": "2019-08-01T11:29:19+0800"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status: 400
{
"code": 30202,
"message": "Invalid template_invoke_name"
}
{
"code": 30202,
"message": "Invalid template_invoke_name"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Hinzufügen
URL
https://email.api.engagelab.cc/v1/templates
https://email.api.engagelab.cc/v1/templates
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
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| name | string | ja | Name der E-Mail-Vorlage. Maximale Länge: 32 Zeichen. |
| template_invoke_name | string | ja | Name der aufgerufenen E-Mail-Vorlage. 4–64 Zeichen. |
| html | string | ja | Inhalt im HTML-Format |
| text | string | nein | Inhalt im Textformat (optional) |
| subject | string | ja | Betreff der E-Mail-Vorlage. Maximale Länge: 255 Zeichen, Emojis werden unterstützt. |
| preview_text | string | nein | Vorschautext der E-Mail-Vorlage. Maximale Länge: 255 Zeichen. |
Tipp:
- Variablen sind im HTML-Inhalt erlaubt.
- Die Gesamtgröße einer E-Mail darf beim Versand 70 MB nicht überschreiten.
Beispiel für eine Anfrage
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' \
'https://email.api.engagelab.cc/v1/templates'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' \
'https://email.api.engagelab.cc/v1/templates'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| template_id | ID der E-Mail-Vorlage |
| name | Name der E-Mail-Vorlage |
| template_invoke_name | Name der aufgerufenen E-Mail-Vorlage |
| html | Inhalt im HTML-Format |
| text | Inhalt im Textformat |
| subject | Betreff der E-Mail-Vorlage |
| preview_text | Vorschautext der E-Mail-Vorlage |
| create_time | Zeitpunkt der Erstellung der Vorlage |
| update_time | Zeitpunkt der letzten Änderung der Vorlage |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{
"result": {
"template_id": 82525,
"name": "zhongg",
"template_invoke_name": "gjtest122",
"html": "This first template for apiv3",
"subject": "xxxxxxx",
"preview_text": "",
"create_time": "2022-11-14T15:31:17+0800",
"update_time": ""
}
}
{
"result": {
"template_id": 82525,
"name": "zhongg",
"template_invoke_name": "gjtest122",
"html": "This first template for apiv3",
"subject": "xxxxxxx",
"preview_text": "",
"create_time": "2022-11-14T15:31:17+0800",
"update_time": ""
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status: 400
{
"code": 30202,
"message": "Invalid template_invoke_name"
}
{
"code": 30202,
"message": "Invalid template_invoke_name"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Löschen
URL
https://email.api.engagelab.cc/v1/templates/{template_id}
https://email.api.engagelab.cc/v1/templates/{template_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
DELETE
DELETE
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Beispiel für eine Anfrage
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/templates/11111111'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/templates/11111111'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| count | Anzahl der gelöschten E-Mail-Vorlagen |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{ "count": 1 }
{ "count": 1 }
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Bearbeiten
Sie können Name, Inhalt, Betreff und Typ der E-Mail-Vorlage bearbeiten.
URL
https://email.api.engagelab.cc/v1/templates/{template_id}
https://email.api.engagelab.cc/v1/templates/{template_id}
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
PUT
PUT
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| name | string | nein | Name der E-Mail-Vorlage. Maximale Länge: 32 Zeichen. |
| template_invoke_name | string | nein | Name der aufgerufenen E-Mail-Vorlage. 4–64 Zeichen. |
| html | string | nein | Inhalt im HTML-Format |
| text | string | nein | Inhalt im Textformat (optional) |
| subject | string | nein | Betreff der E-Mail-Vorlage. Maximale Länge: 255 Zeichen, Emojis werden unterstützt. |
| preview_text | string | nein | Vorschautext der E-Mail-Vorlage. Maximale Länge: 255 Zeichen. |
Tipp:
- Variablen sind im HTML-Inhalt erlaubt.
- Beim Versand darf die Gesamtgröße der E-Mail 70 MB nicht überschreiten.
Beispiel für eine Anfrage
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"template_invoke_name": "myCustomTemplate"}' \
'https://email.api.engagelab.cc/v1/templates/11111111'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"template_invoke_name": "myCustomTemplate"}' \
'https://email.api.engagelab.cc/v1/templates/11111111'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| count | Anzahl der bearbeiteten E-Mail-Vorlagen |
Beispiel für Rückgabewerte
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Diesen Codeblock im schwebenden Fenster anzeigen
