sendEmail¶

Request Method: POST

Description: Send an Email

URL: https://api.iovox.com:444/SMS?v=3&method=sendEmail

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES

Payload¶

The following XML payload must be sent with a sendEmail request:

<?xml version="1.0" encoding="utf-8"?>
<request>
    <link_id>email_link_tracking_id</link_id>
    <from>iovoxtestsender@iovox.com</from>
    <from_name>Iovox Limited</from_name>
    <to>iovoxtestreceiver@iovox.com</to>
    <subject>This is the subject</subject>
    <content><![CDATA[<!DOCTYPE html><html> this is an example content <p>new paragraph</p></html>]]></content>
</request>

Payload Description¶

The following parameters can be sent in the querystring

Node Name	Description	Default Value	Data Type	Mandatory
link_id	Link id of the tracking element we want to be send from		STRING	YES
from	From address of the sender		STRING	YES
to	The address will receive the email		STRING	YES
subject	The subject of the email		STRING	YES
content	The content of the email		STRING	YES

Result¶

Error Result¶

HTTP Code	Error String	Resolution
400	API Version Empty	Add a value for the v parameter in the query string
400	API Version Invalid	Correct v parameter
400	Request Method must be POST. x attempted	Switch request method x to POST
400	XML Empty	Add xml to the request body
400	XML parse error. x at line y, column z	Correct XML at point x on line y, column z
400	Request Empty	Add at least one node to the request
400	Link ID Empty	Add a valid link_id
400	Link ID does not exist	Correct link_id
400	From is not valid email address	Correct from
400	From Name Empty	Add a from_name
400	To is not valid email address	Correct to
400	Subject Empty	Add a subject
400	Content Empty	Correct content
500	Internal Server Error	Retry later

Success Result¶

HTTP/1.1 201 Created

<?xml version="1.0" encoding="UTF-8"?>
<response>
        <id>d454cfe0-a835-11e6-9852-d43d7ed6ce4c</id>
</response>