This API method is designed for sending single email with optional parameters.
This request allows you to send emails with both text and HTML content, and optionally include inline media, such as images or other files, which are embedded directly in the email body for a richer user experience.
| PUT (POST) https://api.bsg.world/api/email/send-emails |
| Parameter | Required | Type | Description |
|---|---|---|---|
| to | Yes | array | A list of recipient email addresses. |
| from | Yes | string | The sender’s email address. |
| subject | Yes | string | The subject line of the email. |
| body | Yes | string | The plain-text content of the email body. |
| htmlbody | Yes | string | The HTML-formatted content of the email body (can include rich text elements). |
| inlines | No | array | A list of inline attachments. Each inline item includes the following fields: |
| name | Yes | string | A variable representing the name or identifier of the inline attachment. |
| cid | Yes | string | The content identifier (links the inline attachment to the email body). |
| contentType | Yes | string | The content type (e.g., “image/png”). |
| content | Yes | string | The base64-encoded content of the inline attachment. |
{
"to": [
"[email protected]"
],
"from": "[email protected]",
"subject": "string",
"body": "string",
"htmlbody": "string",
"inlines": [
{
"name": "string",
"cid": "string",
"contentType": "string",
"content": "string"
}
]
| Parameter | Type | Description |
|---|---|---|
| message_id | string | A unique identifier for the message sent. |
If the request is successful, you will receive a response:
{
"message_id": "string"
}