Aurora API: Customer Email

Email

Send

Deferred: Yes

This method is intended to allow third parties to trigger genuine Aurora emails over the API. This is most commonly used for sending password reset emails to customers, but can be used to send any pre-configured email template or even custom messages from Aurora to a customer.

🚧

This method should NOT be used for emailing customers regarding an order. No order information is available via this method and emails will not be logged against the customer's order history.

To contact a customer regarding a specific order, please use the OrderEmailSend method.

Example request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <Customer>
                <Email>
                    <Send>
                        <RequestID>1</RequestID>
                        <CustomerID>1234</CustomerID>
                        <Template>Custom: Forgot Password</Template>
                    </Send>
                </Email>
            </Customer>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example response:

<?xml version="1.0" encoding="utf-8"?>
 <AuroraResponseEnvelope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>1</RequestsSucceeded>
             <RequestErrors>0</RequestErrors>
         </Summary>
     </Header>
     <Responses>
         <Response>
             <RequestID>1</RequestID>
             <Ack>OK</Ack>
                 <CustomerID>1234</CustomerID>
                 <Email>
                     <Subject>Aurora Demo: A message for your attention</Subject>
                     <Reference>5fa4dd21ae1e8b2b86e0d3b43dbdf6a4</Reference>
                 </Email>
             </Data>
         </Response>
     </Responses>
</AuroraResponseEnvelope>

The 'Reference' field can be used to view the email in a browser and is often provided to the customer to support the 'Having trouble viewing this email in your email client' feature. To use this code to view the content of the email sent to the customer, simply add it the the end of the URL '/emails/?ref='.

For example:

http://www.example.com/emails/?ref=5fa4dd21ae1e8b2b86e0d3b43dbdf6a4

Request Fields