Gallup OMS Web Service Documentation

ConsumerEmailOptOutRequest

October2010

Allows a user to opt-out to marketing emails.

Service:People
Method:SetPreferences
Permission:ConsumerEmailOptOutRequest

Properties

Name Type Required Description
MarketingCategories MarketingCategoryBulkIdentifier Required
IPAddress String Required
EmailAddress String Required

Exceptions

Exception Severity Code Condition
ArgumentMissing Critical 10010001 A required request input has not been specified.
IdentifierDoesNotExist Critical 10010002 The specified membership interaction identifier does not exist.
MultipleRecordsFound Critical 10010004 Multiple records found for the identifier.
DuplicateInputFound Critical 10010015 Duplicate input was found.

Examples

The following is an XML example of the ConsumerEmailOptOutRequest sent to the People.SetPreferences method. 

<soapenv:Envelope xmlns:ns="http://schemas.gallup.com/oms/2010/10/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header />
  <soapenv:Body>
    <ns:SetPreferences xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <ns:request i:type="a:ConsumerEmailOptOutRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/People">
        <a:MarketingCategories i:type="b:MarketingCategoryBulkCodeNameIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:CodeNames i:nil="true" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </a:MarketingCategories>
        <a:IPAddress>1.0.0.0</a:IPAddress>
        <a:EmailAddress>someone@somewhere.com</a:EmailAddress>
      </ns:request>
    </ns:SetPreferences>
  </soapenv:Body>
</soapenv:Envelope>

[PRINT]© Gallup, Inc. All Rights Reserved. All information contained on this site is the property of Gallup and contains proprietary trade secrets of Gallup. This information is confidential and protected under the confidentiality agreements signed by each Gallup employee, and is to be used solely by Gallup employees in the performance of their responsibilities. None of the information contained in this site is to be copied, viewed, forwarded, downloaded or shred outside of Gallup without permission.

© Gallup, Inc. All Rights Reserved. All information contained on this site is the property of Gallup and contains proprietary trade secrets of Gallup. This information is confidential and protected under the confidentiality agreements signed by each Gallup employee, and is to be used solely by Gallup employees in the performance of their responsibilities. None of the information contained in this site is to be copied, viewed, forwarded, downloaded or shred outside of Gallup without permission.