ClientEmailOptInRequest
Allows a user to opt-in to client emails.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Client | ClientIdentifier | 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. |
Examples
The following is an XML example of the ClientEmailOptInRequest 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:ClientEmailOptInRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/People">
<a:Client i:type="b:ClientIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
<b:ClientId>1234</b:ClientId>
</a:Client>
<a:IPAddress>1.0.0.0</a:IPAddress>
<a:EmailAddress>someone@somewhere.com</a:EmailAddress>
</ns:request>
</ns:SetPreferences>
</soapenv:Body>
</soapenv:Envelope>