POST /smtp/email
The POST /smtp/email
endpoint is used to send an email via SMTP. The request should include the sender's information, recipient's information, email content, subject, reply-to information, and optional tags.
Request Body
sender
: Object containing the name and email of the sender.name
: (string) Name of the sender.email
: (string) Email address of the sender.
to
: Array of objects containing the name and email of the primary recipients.name
: (string) Name of the recipient.email
: (string) Email address of the recipient.
cc
: Array of objects containing the name and email of the CC recipients.name
: (string) Name of the CC recipient.email
: (string) Email address of the CC recipient.
bcc
: Array of objects containing the name and email of the BCC recipients.name
: (string) Name of the BCC recipient.email
: (string) Email address of the BCC recipient.
htmlContent
: (string) HTML content of the email.subject
: (string) Subject of the email.replyTo
: Object containing the name and email for the reply-to address.name
: (string) Name for the reply-to address.email
: (string) Email address for the reply-to address.
tags
: Array of strings representing tags associated with the email.
Response
The response will contain a JSON object with the messageId
field, which represents the unique identifier for the sent email.
Example Response Schema
{
"type": "object",
"properties": {
"messageId": {
"type": "string"
}
}
}
Servers
- {{baseUrl}}
- https://api.sendinblue.com
- https://in-automate.sendinblue.com
- https://in-automate.brevo.com
- https://api.brevo.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
|
String | No |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
htmlContent |
String | No | |
messageVersions[] |
Array | No | |
messageVersions[].to[] |
Array | No | |
messageVersions[].to[].email |
String | No | |
messageVersions[].to[].name |
String | No | |
messageVersions[].params |
Object | No | |
messageVersions[].params.dolore__b |
Object | No | |
messageVersions[].params.Lorem749 |
Object | No | |
messageVersions[].cc[] |
Array | No | |
messageVersions[].cc[].email |
String | No | |
messageVersions[].cc[].name |
String | No | |
messageVersions[].bcc[] |
Array | No | |
messageVersions[].bcc[].email |
String | No | |
messageVersions[].bcc[].name |
String | No | |
messageVersions[].replyTo |
Object | No | |
messageVersions[].replyTo.email |
String | No | |
messageVersions[].replyTo.name |
String | No | |
messageVersions[].subject |
String | No | |
replyTo |
Object | No | |
replyTo.email |
String | No | |
replyTo.name |
String | No | |
textContent |
String | No | |
sender |
Object | No | |
sender.id |
Number | No | |
sender.email |
String | No | |
sender.name |
String | No | |
scheduledAt |
String | No | |
subject |
String | No | |
attachment[] |
Array | No | |
attachment[].name |
String | No | |
attachment[].url |
String | No | |
attachment[].content |
String | No | |
to[] |
Array | No | |
to[].email |
String | No | |
to[].name |
String | No | |
params |
Object | No | |
params.Utf08 |
Object | No | |
batchId |
String | No | |
templateId |
Number | No | |
cc[] |
Array | No | |
cc[].email |
String | No | |
cc[].name |
String | No | |
bcc[] |
Array | No | |
bcc[].email |
String | No | |
bcc[].name |
String | No | |
tags[] |
Array | No | |
headers |
Object | No | |
headers.ut_86_ |
Object | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.