Send Email
POST/apis/v1/sendThis API will send a new fresh email.
Make sure that the email that you pass in from field is a registered email in the Mailcompose Dashboard.
To add a new sender
- Login into the Mailcompose Dashbord
- Click on Send Now
- Click on Add a new Sender
Request
Header Params
Api-Key
string
required
Example:
xyz-xyz-xyz-xyz-xyz
Api-Secret
string
required
Example:
xyz-xyz-xyz-xyz-xyz
User-Agent
string
optional
Example:
YourCompanyName
Content-Type
string
required
Example:
application/json
Body Params application/json
from
string <email>
required
Example:
invoices@yourcompany.com
to
array[string <email>]
to
>= 1 items
cc
array[string <email>]
optional
bcc
array[string <email>]
optional
subject
string
required
text
string
required
html
string
optional
attachments
array [object {3}]
optional
filename
string
required
Example:
att1.jpg
contentType
string
required
Example:
image/jpeg
base64
string
required
Example:
iYQ...
Example
{
"from": "invoices@yourcompany.com",
"to": [
"user@example.com"
],
"cc": [
"user@example.com"
],
"bcc": [
"user@example.com"
],
"subject": "string",
"text": "string",
"html": "string",
"attachments": [
{
"filename": "att1.jpg",
"contentType": "image/jpeg",
"base64": "iYQ..."
}
]
}Request samples
Responses
Success(200)
Free Plan Limit Exceeded(402)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean
required
payload
object
required
messageId
string
required
Example:
snmdkm2k3em2@sub.domain.com
mailcomposeEmailId
string
required
Example:
makcwi2d2w1212e
threadId
string
required
Example:
tsdvjne12e12pkm1pk
Example
{
"success": true,
"payload": {
"messageId": "snmdkm2k3em2@sub.domain.com",
"mailcomposeEmailId": "makcwi2d2w1212e",
"threadId": "tsdvjne12e12pkm1pk"
}
}Last modified: 3 months ago