Update Account Message Settings

Description

Update the account's message settings for an event context.

HTTP Method

POST

Path

/account/email/{campaignId}

Authentication

Requires an authenticated user.

Parameters

Table 2.  Parameters for " Update Account Message Settings "

NameTypeValue TypeDescription
campaignIdPATHlongthe Id of the event for which the message settings are configured. For generic message settings, use 0 for this parameter.
messageNetworkUpdatesFORMString(optional) Defines email frequency for account's connections updates. This is only valid for the generic Poken campaign (campaignId=0). (posible values - DAILY, WEEKLY, NO_EMAIL, INHERITED )
messageRecentCollectedFORMString(optional) Defines how often this account should recieve emails with recent collected people and objects (Message frequency values - DAILY, WEEKLY, NO_EMAIL )
messageEventUpdatesFORMBoolean(optional) 'true' to recieve emails related to this event.
messageMeetingInvitationFORMString(optional) Defines the message frequency for meeting invitations for this event. (Message frequency values - EMAILS_SMS, EMAILS, NO_EMAIL, INHERITED )
messageMeetingReminderFORMString(optional) Defines the message frequency for meeting reminders of this event. (Message frequency values - EMAILS_SMS, EMAILS, NO_EMAIL, INHERITED )
messageSessionInvitationFORMString(optional) Defines the message frequency for session invitations for this event. (Message frequency values - EMAILS_SMS, EMAILS, NO_EMAIL, INHERITED )
messageSessionReminderFORMString(optional) Defines the message frequency for session reminders of this event. (Message frequency values - EMAILS_SMS, EMAILS, NO_EMAIL, INHERITED )

Error Codes

10000 ( Account )

An unhandled exception has occured.

10019 ( Account )

The account specified is invalid.

10036 ( Account )

The account is not part of the provided campaign

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="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="success" type="tns:Status" default="FAILURE" minOccurs="0"/>
        <xs:element name="error" type="tns:Error" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="Error">
    <xs:sequence>
      <xs:element name="code" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="Status">
    <xs:restriction base="xs:string">
      <xs:enumeration value="SUCCESS"/>
      <xs:enumeration value="FAILURE"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://xsd.poken.com">
	<success>SUCCESS</success>
</response>