GET api/v2.0/Contacts/GetMyEmailPreferences
Responds with the Currently Authenticated User's Global Email Opt-in/out settings.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
A List of Email Preferences for the Current User.
Collection of EmailPreference| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageClass |
Integer value that represents a specific MessageClass. Please refer to the MessageClass object to see descriptions of valid values. |
MessageClass |
None. |
| OptOut |
Boolean specifying whether to Opt-out of the MessageClass specified. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"MessageClass": 0,
"OptOut": true
},
{
"MessageClass": 0,
"OptOut": true
}
]
application/xml, text/xml
Sample:
<ArrayOfEmailPreferenceUpdateRequest.EmailPreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
<EmailPreferenceUpdateRequest.EmailPreference>
<MessageClass>All</MessageClass>
<OptOut>true</OptOut>
</EmailPreferenceUpdateRequest.EmailPreference>
<EmailPreferenceUpdateRequest.EmailPreference>
<MessageClass>All</MessageClass>
<OptOut>true</OptOut>
</EmailPreferenceUpdateRequest.EmailPreference>
</ArrayOfEmailPreferenceUpdateRequest.EmailPreference>