GetAllCustomerCommunicationPreferences
| Initial Build | xxxx.x |
| xWeb | Web Method |
| Response Type | XML results |
The GetAllCustomerCommunicationPreferences web method returns all of a customer's communication preferences. To get a customer's communication preferences for just a single mailing type, use GetCustomerCommunicationPreference.
Assuming you're attempting to update a customer's preferences, you can adjust the results that come back from this web method and pass the updates into SetCustomerCommunicationPreferences.
Parameters
The request contains the following parameters:
| Name | Type | Occurs | Description |
|---|---|---|---|
| customerKey | string | 1..1 | The customer key. |
Response
The request returns an array of MailingListSetting records.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>1385f3cf-4a8f-4059-9cc4-55b958f88b2b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:GetAllCustomerCommunicationPreferences>
<ns:customerKey>5d11b235-693a-404b-aadb-77a4fc319fd6</ns:customerKey>
</ns:GetAllCustomerCommunicationPreferences>
</soapenv:Body>
</soapenv:Envelope>Sample Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>1385f3cf-4a8f-4059-9cc4-55b958f88b2b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<GetAllCustomerCommunicationPreferencesResponse xmlns="http://www.avectra.com/2005/">
<GetAllCustomerCommunicationPreferencesResult>
<MailingListSetting>
<mailing_list_key>fe7324d8-1016-454c-a2fb-16f5dd07453a</mailing_list_key>
<mailing_list_name>test-8008</mailing_list_name>
<mailing_list_category>Participation</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>679ee299-e6ef-4064-a1de-29e2fa218d81</mailing_list_key>
<mailing_list_name>KLREG Mailing List</mailing_list_name>
<mailing_list_category>event</mailing_list_category>
<status>OptIn</status>
<email_key>984b56f0-8875-4779-969a-16c366f11314</email_key>
<address_key>cee04154-199b-4bb4-9d4d-010eecd3062d</address_key>
<phone_key>f6c64b23-1110-4029-8be5-a2ada3b62544</phone_key>
<fax_key>c0229559-ac17-414c-ba34-b42207ab0bed</fax_key>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>e86b36bf-7ca2-4919-ad2e-3a7ef268ab39</mailing_list_key>
<mailing_list_name>6334MailList</mailing_list_name>
<mailing_list_category>event</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>c0ccc113-9239-4e5d-8e89-4892d3514d9c</mailing_list_key>
<mailing_list_name>cm - ml - 01</mailing_list_name>
<mailing_list_category>cm - mlt - 01</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>c052f2cd-3102-4967-b05a-4eccfb15a5fa</mailing_list_key>
<mailing_list_name>11357 End Date</mailing_list_name>
<mailing_list_category>promotional</mailing_list_category>
<status>OptIn</status>
<email_key>984b56f0-8875-4779-969a-16c366f11314</email_key>
<address_key>cee04154-199b-4bb4-9d4d-010eecd3062d</address_key>
<phone_key>f6c64b23-1110-4029-8be5-a2ada3b62544</phone_key>
<fax_key>c0229559-ac17-414c-ba34-b42207ab0bed</fax_key>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>0a74f569-b156-432f-a26c-4ffc591590eb</mailing_list_key>
<mailing_list_name>KM mailing list</mailing_list_name>
<mailing_list_category>event</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>56c8933a-8cdd-492b-8b85-50c004644d42</mailing_list_key>
<mailing_list_name>Craig's List</mailing_list_name>
<mailing_list_category>promotional</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>2a67680a-bac4-4205-98d8-52731e15e0c0</mailing_list_key>
<mailing_list_name>456-new</mailing_list_name>
<mailing_list_category>promotional</mailing_list_category>
<status>OptIn</status>
<email_key/>
<address_key>23ea5b4c-9a30-42fc-bfeb-999f1e21e179</address_key>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>ec5c51b1-866e-4be0-ae4f-5c1b759e9e93</mailing_list_key>
<mailing_list_name>2013ML</mailing_list_name>
<mailing_list_category>promotional</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
<MailingListSetting>
<mailing_list_key>eb2e8db8-a054-46c5-a74e-641f9ec864ce</mailing_list_key>
<mailing_list_name>7234STH01</mailing_list_name>
<mailing_list_category>7234STH01-MailType</mailing_list_category>
<status>OptOut</status>
<email_key/>
<address_key/>
<phone_key/>
<fax_key/>
</MailingListSetting>
</GetAllCustomerCommunicationPreferencesResult>
</GetAllCustomerCommunicationPreferencesResponse>
</soap:Body>
</soap:Envelope>JSON Method
GET /xWeb/JSON/GetAllCustomerCommunicationPreferences?customerKey={{indCstKeyInsert}}
POST /xWeb/JSON/GetAllCustomerCommunicationPreferences
DATA: JSON
{
"GetAllCustomerCommunicationPreferences": {
"customerKey": "FADFF57B-C6EF-4130-BE1E-07000A38056F"
}
}SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON{
"MailingListSettings": {
"@xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
"@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"MailingListSetting": [
{
"mailing_list_key": "b31c52e4-29c1-4a65-8c53-0626342c920d",
"mailing_list_name": "Instructors - Online",
"mailing_list_category": "Instructors",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "06bc2685-1d1a-4bd3-97bd-0b588ba2b34d",
"mailing_list_name": "webinar seed list ",
"mailing_list_category": "Testing",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "1ef28e36-d41c-4697-ac49-1ab2872bdf6a",
"mailing_list_name": "Instructors - Contract Trainer",
"mailing_list_category": "Instructors",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "a3a32606-97de-4d9e-a130-1d01615fd2bf",
"mailing_list_name": "TEST Informing Online Students",
"mailing_list_category": "Testing",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "6cc179ee-99c3-4b6b-8bab-36574550a5e5",
"mailing_list_name": "Accreditation",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "423975ca-eed8-4913-a4af-4a4b4c1e69be",
"mailing_list_name": "2019 Forum & VCON Attendees",
"mailing_list_category": "Email Opt-In",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "6590cb41-c24f-4a53-b99a-5c1747e3c8ab",
"mailing_list_name": "Client Sponsors",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "e1b0a04c-fc66-4f1d-af09-675784cd1c7f",
"mailing_list_name": "Newsletter (NForm) ",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "10721bb8-2a9e-4f00-b230-7b68cf5abc94",
"mailing_list_name": "sc test",
"mailing_list_category": "UPPCC Approval",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "2593a8e7-ee8f-4087-93fd-89bebc642cd4",
"mailing_list_name": "Libby Test Seed List",
"mailing_list_category": "Testing",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "c73d3858-5bd0-4ce5-b795-91aca1502a73",
"mailing_list_name": "Professional Development",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "cd770476-09f5-46e3-bd8a-933400c933a8",
"mailing_list_name": "Research",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "bf5e6612-acd1-4987-a5ed-9702ea7956ef",
"mailing_list_name": "2018 Forum Attendees",
"mailing_list_category": "Email Opt-In",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "dbc8de0f-8e88-4695-a785-9b491546683b",
"mailing_list_name": "Member Communications",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "9242ecad-4326-4ec7-b7d7-b8afd4852219",
"mailing_list_name": "Job Postings",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "904324d0-213d-4163-859b-bad9a3047974",
"mailing_list_name": "Act-On Do Not Email",
"mailing_list_category": "Email Opt-In",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "c9e4976f-ad47-46b6-92db-f32df689ec6c",
"mailing_list_name": "Forum seed list",
"mailing_list_category": "Testing",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "0d182a7c-b5e6-4cf9-8df3-f9446a972459",
"mailing_list_name": "Events",
"mailing_list_category": "Email Opt-In",
"status": "OptIn",
"email_key": "abc320db-863f-441a-8ab4-5fc827fc33c2",
"address_key": "0f37de1d-a608-4ebc-bad1-7beaa3102f60",
"phone_key": "f46291d8-6b16-467f-97ef-fb16028a2b98",
"fax_key": "bac08813-3231-4c42-942e-2e0d98608043"
},
{
"mailing_list_key": "4872e830-d70e-40c0-92aa-fbf0de04fb4a",
"mailing_list_name": "CAPPO Partition",
"mailing_list_category": "Partition ",
"status": "OptOut",
"email_key": null,
"address_key": null,
"phone_key": null,
"fax_key": null
},
{
"mailing_list_key": "538d27df-ee32-40ee-a516-169e6aab92a4",
"mailing_list_name": "Receive Blast Emails from NetForum",
"mailing_list_category": "Email Opt-In",
"status": "OptOut",
"email_key": "1a18b29c-57e4-4f75-88ec-f850c37edb22",
"address_key": null,
"phone_key": null,
"fax_key": null
}
]
}
}
More information