Aurora API: MailingList Subscription

This group of methods allows you to manage customer mailing list subscriptions.

Add

Deferred: No

The method allows mailing list subscriptions to be created for a given List, Email Address and OptOut value.

Example Request:

<AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <MailingList>
                <Subscription>
                    <Add>
                        <RequestID>1</RequestID>
                        <ListName>Aurora</ListName>
                        <EmailAddress>[email protected]</EmailAddress>
                        <OptOut>no</OptOut>
                    </Add>
                </Subscription>
            </MailingList>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example response:

<AuroraResponseEnvolope>
    <Header>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Data>
                <MailingList>
                    <Subscription>
                        <ListName>Aurora</ListName>
                        <EmailAddress>[email protected]</EmailAddress>
                        <OptOut>no</OptOut>
                        <Date>2020-01-21T14:34:21+00:00</Date>
                        <Source>Newsletter</Source>
                    </Subscription>
                </MailingList>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvolope>

Update

Deferred: No

The method allows mailing list subscriptions to be updated for a given List, Email Address and OptOut value. If a record is found for a valid List Name and Email Address the OptOut value will be updated.

Example Request:

<AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <MailingList>
                <Subscription>
                    <Update>
                        <RequestID>1</RequestID>
                        <ListName>Aurora</ListName>
                        <EmailAddress>[email protected]</EmailAddress>
                        <OptOut>no</OptOut>
                    </Update>
                </Subscription>
            </MailingList>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example Response:

<AuroraResponseEnvolope>
    <Header>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Data>
                <MailingList>
                    <Subscription>
                        <ListName>Aurora</ListName>
                        <EmailAddress>[email protected]</EmailAddress>
                        <OptOut>no</OptOut>
                        <Date>2020-01-21T14:34:21+00:00</Date>
                        <Source>Newsletter</Source>
                    </Subscription>
                </MailingList>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvolope>

Request Fields

Field	Values	API Version	Description	Required
ListName	String	1.5+	The list name for which to add or update the subscription.	Yes
EmailAddress	String	1.5+	The email address to be subscribed.	Yes
OptOut	yes or no	1.5+	Whether the user is to be opted out of correspondence.	Yes

Get

Deferred: No

This method will allow a mailing list subscription to be retrieved based on a give List Name and Email Address.

This is currently limited to a single email address for performance considerations.

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>
            <MailingList>
                <Subscription>
                    <Get>
                        <RequestID>1</RequestID>
                        <ListName>Aurora</ListName>
                        <EmailAddresses>
                            <EmailAddress>[email protected]</EmailAddress>
                        </EmailAddresses>
                    </Get>
                </Subscription>
            </MailingList>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example Response:

<AuroraResponseEnvolope>
    <Header>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Data>
                <MailingList>
                    <Subscription>
                        <ListName>Aurora</ListName>
                        <EmailAddress>[email protected]</EmailAddress>
                        <OptOut>no</OptOut>
                        <Date>2020-01-21T14:34:21+00:00</Date>
                        <Source>Newsletter</Source>
                    </Subscription>
                </MailingList>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvolope>

Request Fields

Field	Values	API Version	Description	Required
ListName	String	1.5+	The list name for which to retrieve the subscription.	Yes
EmailAddresses	Container	1.5+		Yes
EmailAddresses.EmailAddress	String	1.5+	The email address used to identify the subscription. This is currently limited to one email address for performance reasons.	Yes

Response fields

Field	Values	API Version	Description
ListName	Integer > 0	1.5+	The list name of the subscription.
EmailAddress	String	1.5+	The email address of the subscription.
OptOut	String	1.5+	Whether the user has opted out of the subscription.
Date	SO 8601 date	1.5+	The date and time that the mail list subscription was created in ISO 8601 date format, e.g. 2004-02-12T15:19:21+00:00
Source	String	1.5+	The source of the subscription i.e. * Order = user has been subscribed during order creation. * Newsletter = user has either subscripted via the Aurora newsletter signup process or been subscribed via the API.

Updated 13 days ago