Moves a contact in an Acoustic Campaign database to an opted‐out state.
When using a custom opt-out page...
If you use a custom opt-out page and wish to record opt-outs against specific mailings, the link to your opt-out page within your mailing templates must include the following parameters:
%%MAILING_ID%%
%%RECIPIENT_ID%%
%%JOB_ID_CODE%%
Elements (Required)
LIST_ID - Identifies the ID of the database where the opt-out contact is located.
EMAIL - The contact email address to opt-out.
Note: If using a regular email key database, a node must exist for the Email column. Acoustic Campaign does not require EMAIL if MAILING_ID, RECIPIENT_ID, and JOB_ID are all passed.
MAILING_ID - The internal mailing ID passed to the opt-out page using personalized links in the mailing template to track opt-outs at the mailing level.
RECIPIENT_ID - The internal ID of the contact passed to the opt-out page using personalized links in the mailing template to track opt-outs at the mailing level.
JOB_ID - The internal Job ID passed to the opt-out page using personalized links in the mailing template to track opt-outs at the mailing level.
COLUMN - XML nodes defining the column name and value. Ignored for regular email key databases.
Note: Unique key columns must be part of the submission with column names and values. If only the email address is specified, the system opts-out all contacts with that email address.
NAME - A child of COLUMN and specifies the field name of the unique key for the database.
VALUE - A child of COLUMN and specifies the value of the field name for the unique key in the database.
<Envelope>
<Body>
<OptOutRecipient>
<LIST_ID>45654</LIST_ID>
<EMAIL>[email protected]</EMAIL>
<COLUMN>
<NAME>CustomerId</NAME>
<VALUE>123-45-6789</VALUE>
</COLUMN>
</OptOutRecipient>
</Body>
</Envelope>
<Envelope>
<Body>
<OptOutRecipient>
<LIST_ID>45035</LIST_ID>
<MAILING_ID>132767</MAILING_ID>
<RECIPIENT_ID>0Ng3S0</RECIPIENT_ID>
<JOB_ID>NTQ5NTk5MwS2</JOB_ID>
</OptOutRecipient>
</Body>
</Envelope>
<Envelope>
<Body>
<RESULT>
<SUCCESS>SUCCESS</SUCCESS>
</RESULT>
</Body>
</Envelope>
Elements (Response)
SUCCESS - SUCCESS if successful.
ORGANIZATION_ID - Identifies your Acoustic Campaign organization.
Reliability measures
A SUCCESS response indicates that the system can and will opt-out the contact. However, this may not happen immediately. Acoustic Campaign places all opt-out events in a queue and processes them in the order that they are received. If an internal error occurs while processing the event from the queue, Acoustic Campaign places the event in an error queue until the problem is resolved and returns to the event queue.
The following errors can result in an unsuccessful request:
- Invalid field formats
- Database does not exist in Campaign
- Missing parameters when opting out for a particular mailing
- Database prohibits opting out through API
- Limited rights on the related database
To ensure opt‐out reliability, you should continue to retry any opt‐out requests that do not receive a response until you receive a SUCCESS response. Documenting any responses other than SUCCESS will assist customer support in a manual investigation, if necessary.