Call us toll free @ 888-497-7898

email - sendsingleemail

Allows to send a single email to a recipient
This is not meant for HIGH volume. Max a few thousand per day. For higher volumes use the createcampaign api's to send to a list of emails. Or the SMTP API.

To pass in custom fields for personalization
Add the following to your url
cus_fieldnamehere=datahere
Replace fieldnamehere with your custom field name.

API Call Information
area: email
action: sendsingleemail

API Arguments

Argument	Data Type	Required	Description
email	string	Yes	email address of the recipient
subject	string	Yes	your subject line
profileid	integer	Yes	profile id to send the campaign from
whoisid	integer	Yes	can spam/whois footer id
fromaddress	string	Yes	the prefix of the email address such as info jobs sales
fromname	string	Yes	name/company the email is from
messageid	integer	No	message id for the message
message	string	No	body of message if no message id
htmlmsg	string	No	html message part if no message id. Exactly the same as the message parameter.
textmsg	string	No	text message part of the message not required
sendtexthtml	boolean either 1 or 0	No	either 1 or 0 for on or off to send both the html part and text message part. No DKIM
date	integer	No	unixtime stamp of date or leave out to send right now. Time is based on CST timezone.
dkim	boolean either 1 or 0	No	values either 0 or 1 for having it or not
viewasawebpage	boolean either 1 or 0	No	values either 0 or 1 for having it or not
clicktracking	boolean either 1 or 0	No	values either 0 or 1 for having it or not. If zero links will not be encoded.
copyopen	integer	No	list id to copy openers to
copyclicker	integer	No	list id to copy clickers to
delayhours	integer	No	if set adds adds to the date value x amount of hours to send later.
smtpserver	integer	No	Optional if you want to send from a SMTP Server, include its ID here.

API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=sendsingleemail&email=myemail@aol.com&subject=hello&fromaddress=sales&fromname=John&profileid=12345&messageid=12345&whoisid=12345&dkim=1&viewasawebpage=1

API Result:

XML Response	JSON Response
<response> <success>Single Email Added to Queue</success> <id>12242</id> </response>	{ "success": "Single Email Added to Queue", "id": "12242" }