Basis-URL
https://{tenant}.logzi.com/api/email/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0.
/api/email/get
Abruf einer einzelnen E-Mail-Nachricht anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der E-Mail-Nachricht |
Beispielanfrage
GET /api/email/get?id=55
X-API-KEY: {ihr_api_schluessel}/api/email/clone
Abruf einer Kopie einer bestehenden E-Mail (für einen neuen Versand vorbereitete Vorlage).
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der zu kopierenden E-Mail |
Beispielanfrage
GET /api/email/clone?id=55
X-API-KEY: {ihr_api_schluessel}/api/email/list
Paginierter Abruf der Liste von E-Mails mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_condition[company_user_id] | int | Filter nach ID des versendenden Mitarbeiters |
Beispielanfrage
GET /api/email/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/email/list_receipt
Abruf der Liste der zu einem bestimmten Beleg gesendeten E-Mails.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_condition[receipt_id] | int | ID des Belegs | |
list_condition[company_user_id] | int | Filter nach versendendem Mitarbeiter |
Beispielanfrage
GET /api/email/list_receipt?list_condition[receipt_id]=123
X-API-KEY: {ihr_api_schluessel}/api/email/save
Erstellung oder Änderung einer E-Mail-Nachricht. Für eine neue E-Mail data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neue E-Mail, >0 = Änderung | |
company_user_id | int | ID des versendenden Mitarbeiters | |
email_subject | string | Betreff der E-Mail | |
email_recepient | string | E-Mail-Adresse des Empfängers | |
email_message_raw | string | Textkörper der E-Mail | |
email_message_id | int | ID der E-Mail-Vorlage | |
email_directory_id | int | ID des Ordners | |
email_status_id | int | ID des Status | |
email_ticket_id | int | ID des zugehörigen Tickets |
Beispielanfrage
POST /api/email/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"company_user_id": 3,
"email_subject": "Számla melléklet",
"email_recepient": "ugyfel@pelda.hu",
"email_message_raw": "Kedves Ügyfelünk, mellékeljük a számlát."
}
}/api/email/delete
Löschen einer E-Mail-Nachricht anhand der ID.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der zu löschenden E-Mail |
Beispielanfrage
POST /api/email/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 55 } }/api/email/send_queue
Sofortiger Versand einer E-Mail-Nachricht aus der Versandwarteschlange. Sendet die wartende Nachricht anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der zu sendenden E-Mail |
Beispielanfrage
GET /api/email/send_queue?id=55
X-API-KEY: {ihr_api_schluessel}Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
