Email
The Email endpoints manage mail server settings and notification templates.
For the corresponding user interface, refer to the System Setup > Email section.
Endpoints
GET /email/email_config/
Returns the outgoing mail server settings. Stored credentials are never returned.
Example Request
curl -X GET "https://<your domain>/api/email/email_config/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
POST /email/email_config/
Configures the outgoing mail server used for notifications.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| email_type | integer | Yes | Email type |
| host | string | Yes | Host |
| port | integer | Yes | Port |
| username | string | Yes | Username |
| password | string | Yes | Password |
| created_user | integer | No | Created user |
| created_date | string (date-time) | No | Created date |
| modified_by | integer | No | Modified by |
| Is_deleted | boolean | No | Is deleted |
Example Request
curl -X POST "https://<your domain>/api/email/email_config/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"email_type":1,"host":"string","port":1,"username":"string","password":"string"}'
Responses
| Status Code | Description |
|---|
| 201 | The operation completed. |
GET /email/email_config/{id}/
Returns one mail server configuration by identifier.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this email config_ table. |
Example Request
curl -X GET "https://<your domain>/api/email/email_config/<id>/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
PUT /email/email_config/{id}/
Replaces the configuration. Send the full set of fields.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this email config_ table. |
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| email_type | integer | Yes | Email type |
| host | string | Yes | Host |
| port | integer | Yes | Port |
| username | string | Yes | Username |
| password | string | Yes | Password |
| created_user | integer | No | Created user |
| created_date | string (date-time) | No | Created date |
| modified_by | integer | No | Modified by |
| Is_deleted | boolean | No | Is deleted |
Example Request
curl -X PUT "https://<your domain>/api/email/email_config/<id>/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"email_type":1,"host":"string","port":1,"username":"string","password":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
PATCH /email/email_config/{id}/
Updates selected fields. Send only the fields to change.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this email config_ table. |
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| email_type | integer | Yes | Email type |
| host | string | Yes | Host |
| port | integer | Yes | Port |
| username | string | Yes | Username |
| password | string | Yes | Password |
| created_user | integer | No | Created user |
| created_date | string (date-time) | No | Created date |
| modified_by | integer | No | Modified by |
| Is_deleted | boolean | No | Is deleted |
Example Request
curl -X PATCH "https://<your domain>/api/email/email_config/<id>/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"email_type":1,"host":"string","port":1,"username":"string","password":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
GET /email/email_template/
Returns the notification templates and whether each is enabled. Templates are disabled by default, and no notification is sent until one is enabled.
Example Request
curl -X GET "https://<your domain>/api/email/email_template/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
POST /email/email_template/
Adds a notification template.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| template_type | integer | Yes | Template type |
| subject | string | Yes | Subject |
| content | string | Yes | Content |
| name | string | No | Name |
| created_user | integer | No | Created user |
| created_date | string (date-time) | No | Created date |
| modified_by | integer | No | Modified by |
| Is_deleted | boolean | No | Is deleted |
Example Request
curl -X POST "https://<your domain>/api/email/email_template/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"template_type":1,"subject":"string","content":"string"}'
Responses
| Status Code | Description |
|---|
| 201 | The operation completed. |
GET /email/email_template/{id}/
Returns one template by identifier.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this email template_ table. |
Example Request
curl -X GET "https://<your domain>/api/email/email_template/<id>/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
PUT /email/email_template/{id}/
Replaces the template. Send the full set of fields.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this email template_ table. |
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| template_type | integer | Yes | Template type |
| subject | string | Yes | Subject |
| content | string | Yes | Content |
| name | string | No | Name |
| created_user | integer | No | Created user |
| created_date | string (date-time) | No | Created date |
| modified_by | integer | No | Modified by |
| Is_deleted | boolean | No | Is deleted |
Example Request
curl -X PUT "https://<your domain>/api/email/email_template/<id>/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"template_type":1,"subject":"string","content":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
PATCH /email/email_template/{id}/
Updates selected fields, including whether the template is enabled.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| id | Path | integer | Yes | A unique integer value identifying this email template_ table. |
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| template_type | integer | Yes | Template type |
| subject | string | Yes | Subject |
| content | string | Yes | Content |
| name | string | No | Name |
| created_user | integer | No | Created user |
| created_date | string (date-time) | No | Created date |
| modified_by | integer | No | Modified by |
| Is_deleted | boolean | No | Is deleted |
Example Request
curl -X PATCH "https://<your domain>/api/email/email_template/<id>/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"template_type":1,"subject":"string","content":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
