sendsingleemail

area emailaction sendsingleemailPOSTdestructive

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.

Arguments

ArgumentTypeRequiredDescription
emailstringYesemail address of the recipient
subjectstringYesyour subject line
profileidintegerYesprofile id to send the campaign from
whoisidintegerYescan spam/whois footer id
fromaddressstringYesthe prefix of the email address such as info jobs sales
fromnamestringYesname/company the email is from
messageidintegerNomessage id for the message
messagestringNobody of message if no message id
htmlmsgstringNohtml message part if no message id. Exactly the same as the message parameter.
textmsgstringNotext message part of the message not required
sendtexthtmlboolean (1 or 0)Noeither 1 or 0 for on or off to send both the html part and text message part. No DKIM
dateintegerNounixtime stamp of date or leave out to send right now. Time is based on CST timezone.
dkimboolean (1 or 0)Novalues either 0 or 1 for having it or not
viewasawebpageboolean (1 or 0)Novalues either 0 or 1 for having it or not
clicktrackingboolean (1 or 0)Novalues either 0 or 1 for having it or not. If zero links will not be encoded.
copyopenintegerNolist id to copy openers to
copyclickerintegerNolist id to copy clickers to
delayhoursintegerNoif set adds adds to the date value x amount of hours to send later.
smtpserverintegerNoOptional if you want to send from a SMTP Server, include its ID here.

Example request

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

The platform expects this call as a POST; the parameters are the same either way.

Response

<response>
  <success>Single Email Added to Queue</success>
  <id>12242</id>
</response>

Need a call that isn't here?

Custom integration work is quoted on scope, and support is a person on weekdays, 9am to 5pm CST.