The section describes the JSON request to send an email with API
Required to Submit JSON Request
|
Username |
The email that account holder uses to login SMTP PLANS |
|
API Token |
The API token user has generated using API Configuration section |
|
Method |
POST |
|
Path |
https://portal.smtp-plans.com/API/sendEmail |
Field Details
|
Label/ Variable |
Priority |
Description |
|
smtp_username |
Required |
Requires username of the SMTP you want to send this email from. This would belong to one of the SMTPs available in your account |
|
subject |
Required |
subject line of the email |
|
to |
Required |
recipient of the email, multiple emails can be added as comma separated |
| from_name |
Required |
provide a from name to send your email |
|
from_email |
Required |
provide a from email to send your email |
|
reply_email |
Required |
provide a reply email to receive email replies |
|
content |
Required |
Email messgae to be sent |
|
custom_header |
Optional |
custom header to be included in email message |
Success Response
A text based response with "Success" status will be returned upon submitting a request. The text based message would show the number of emails to which the message has successfully been sent, i.e.
{"status":"success","response":"Email has been sent to 2 Subscribers out of 2"}
If there is only one contact to which API call has attempted to send, then the response will return the contact's email as well, i.e.
{"status":"success","response":"Email has been sent to [email protected]"}