Get Account Message Settings

Description

This method retrieves the account message settings.

HTTP Method

GET

Path

/account/email/settings

Authentication

Requires an authenticated user.

Parameters

Table 1.  Parameters for " Get Account Message Settings "

NameTypeValue TypeDescription
campaignIdQUERYLong(optiona) the ID of the campaign for which to return the account message settings

Error Codes

10000 ( Account )

An unhandled exception has occured.

10019 ( Account )

The account specified is invalid.

150001 ( Common )

The endpoint requires an authenticated account

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="accountMessageSettings">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="campaignSettings" nillable="true" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="campaignId" type="xs:long"/>
              <xs:element name="messageNetworkUpdates" type="xs:string" minOccurs="0"/>
              <xs:element name="messageRecentCollected" type="xs:string"/>
              <xs:element name="messageEventUpdates" type="xs:boolean" minOccurs="0"/>
              <xs:element name="messageMeetingInvitation" type="xs:string"/>
              <xs:element name="messageMeetingReminder" type="xs:string"/>
              <xs:element name="messageSessionInvitation" type="xs:string"/>
              <xs:element name="messageSessionReminder" type="xs:string"/>
              <xs:element name="messageAttendeeSchedule" type="xs:string" minOccurs="0"/>
              <xs:element name="messageAttendeeSurvey" type="xs:string" minOccurs="0"/>
              <xs:element name="messageAttendeeScheduleMeetings" type="xs:string" minOccurs="0"/>
              <xs:element name="messageJoinEvent" type="xs:string" minOccurs="0"/>
              <xs:element name="messagePeopleShouldMeet" type="xs:string" minOccurs="0"/>
              <xs:element name="messagePostEvent" type="xs:string" minOccurs="0"/>
              <xs:element name="messagePostEvent2" type="xs:string" minOccurs="0"/>
              <xs:element name="messagePersonalMessage" type="xs:string" minOccurs="0"/>
              <xs:element name="messageLeadsCollected" type="xs:string" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name="MessageFrequency">
    <xs:restriction base="xs:string">
      <xs:enumeration value="INHERITED"/>
      <xs:enumeration value="DAILY"/>
      <xs:enumeration value="WEEKLY"/>
      <xs:enumeration value="NO_EMAIL"/>
      <xs:enumeration value="ONCE"/>
      <xs:enumeration value="SEND"/>
      <xs:enumeration value="EMAILS_SMS"/>
      <xs:enumeration value="EMAILS"/>
      <xs:enumeration value="SMS"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<accountMessageSettings xmlns="http://xsd.poken.com">
  <campaignSettings>
  	<campaignId>0</campaignId>
    <messageRecentCollected>DAILY</messageRecentCollected>
    <messageNetworkUpdates>NO_EMAIL</messageNetworkUpdates>
    <messageEventUpdates>true</messageEventUpdates>
    <messageMeetingInvitation>EMAILS</messageMeetingInvitation>
    <messageMeetingReminder>EMAILS_SMS</messageMeetingReminder>
    <messageSessionInvitation>EMAILS</messageSessionInvitation>
    <messageSessionReminder>EMAILS_SMS</messageSessionReminder>
  </campaignSettings>
</accountMessageSettings>