Skill Level: Intermediate
If you are using a custom optâout page and wish to record opt outs against specific mailings, you must ensure that the link to your optâout page within your mailing templates includes the following parameters:
Syntax of the request and response XML for OptOutRecipient
SUCCESSÂ in the XML response indicates that the system canâand willâopt out the contact. However, the opt-out may not happen immediately; Watson Campaign Automation places all optâout events in an event queue and processes them in the order in which the events are received. If an internal error occurs while processing the event from the queue, Watson Campaign Automation places the event in an error queue. When the problem is resolved, it moves back into the event queue.
We recommend that you document any responses other thanÂ SUCCESSÂ to assist customer support in a manual investigation, should that be necessary. The following categories of errors can result in an unsuccessful request:
- Invalid field formats
- Database does not exist in Watson Campaign Automation
- 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.
Operation <OptOutRecipient> Elements LIST_ID Â Identifies the ID of the database from which to opt- out the contact. Â Â The contact email address to opt out. Note: If using a regular email key database, anode must exist for the Email column. If passing MAILING_ID, RECIPIENT_ID, andJOB_ID, Watson Campaign Auomation does not require EMAIL. You must provide each of the three elements if EMAIL is not included. Â MAILING_ID Â The internal Mailing ID passed to the optâout page using personalized links in the mailing template. Used 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 inthe mailing template. Used 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. Used to track optâouts at the mailing level. Â COLUMN Â XML nodes defining the column name and value. Ignored for regular email keydatabases. Note: Unique key columns must be part of the submission with columnnames and values. If you only specify the email address, the system will opt-out all contacts with that email address. Â Child Elements Â NAME Specifies the field name of the unique key for the database. Â Â Â VALUE Specifies the value of the field name for the unique key in the database. Example 1
Â Â Â Example 2
Â Â Â Response <RESULT> Â Â Â Elements SUCCESS SUCCESS if successful. Â Â Â ORGANIZATION_ID Identifies your Watson Campaign Automation Organization. Â Â Example
Â Â Â