Base URL
https://{tenant}.logzi.com/api/email/
Every request returns a JSON response. On success result.code == 1, on failure result.code == 0.
/api/email/get
Retrieves a single email message by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the email message |
Example request
GET /api/email/get?id=55
X-API-KEY: {your_api_key}/api/email/clone
Retrieves a copy of an existing email (a template prepared for a new send).
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the email to copy |
Example request
GET /api/email/clone?id=55
X-API-KEY: {your_api_key}/api/email/list
Retrieves a paginated list of emails with filtering options.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition[company_user_id] | int | Filter by sending employee identifier |
Example request
GET /api/email/list?list_offset=0
X-API-KEY: {your_api_key}/api/email/list_receipt
Retrieves the list of emails sent for a given receipt.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_condition[receipt_id] | int | Receipt identifier | |
list_condition[company_user_id] | int | Filter by sending employee |
Example request
GET /api/email/list_receipt?list_condition[receipt_id]=123
X-API-KEY: {your_api_key}/api/email/save
Creates or updates an email message. For a new email use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new email, >0 = update | |
company_user_id | int | Identifier of the sending employee | |
email_subject | string | Email subject | |
email_recepient | string | Recipient email address | |
email_message_raw | string | Email body text | |
email_message_id | int | Email template identifier | |
email_directory_id | int | Folder identifier | |
email_status_id | int | Status identifier | |
email_ticket_id | int | Identifier of the related ticket |
Example request
POST /api/email/save
X-API-KEY: {your_api_key}
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
Deletes an email message by identifier.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the email to delete |
Example request
POST /api/email/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 55 } }/api/email/send_queue
Sends an email message immediately from the send queue. Dispatches the pending message by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the email to send |
Example request
GET /api/email/send_queue?id=55
X-API-KEY: {your_api_key}Create your account now,
pay later!
