generalSettings

The general settings let you define the general settings for an account. Depending on the function you are calling (addAccounts or updateAccounts), different allocation settings will be required. Make sure you view the appropriate Required column for the function you want to call below. Calling readAccounts will return all of the allocations settings associated with the account object.

Name Required for addAccounts(Agency Only) Required for updateAccounts Type Description
emergencyEmail Yes No string The emergency contact email address for the account. This address will be used for notification purposes if a message is unable to be sent due to it exceeding the email allocation. Please use an address which is constantly monitored by some one at your organization.
bounceLimit Yes Yes long The bounce limit set for the account. The bounce limit represents the number of times contacts can consecutively bounce without recorded activity before they are automatically unsubscribed.
dailyFrequencyCap No No long The maximum number of emails an individual contact can receive in a single day from this account.
weeklyFrequencyCap No No long The maximum number of emails an individual contact can receive in a single week from this account.
monthlyFrequencyCap No No long The maximum number of emails an individual contact can receive in a 30 day period from this account.
textDelivery No No boolean If set to 1, when a test delivery is made, two different deliveries will actually get created. One delivery will have the regular (HTML) version of the message. The other delivery will be the plain text version. Each delivery will be treated separately for accounting/tracking purposes.
textPreference No No boolean If set to 1, adds a checkbox to your Webform or Manage Preferences page that lets your contacts choose between receiving text only or HTML messages.
useSSL No No boolean If set to 1, this will encrypt the accounts session using SSL.
currentContacts No No long The total numbers of contacts currently created in the account.
maxContacts No No long The maximum number of contacts allowed in the account for the current allocation period.
currentMonthlyEmails No No long The total number of emails sent this month from the account.
currentHostingSize No No long The current number of hosting space being used by the account.
maxHostingSize No No long The total amount of hosting space allotted to the account.
sendUsageAlerts Yes Agency Only Yes boolean Sends an email when the account exceeds the allocation thresholds if set to 1.
usageAlertEmail Yes Agency Only Yes string The email address that will receive usage alert notifications.
agencyTemplateuploadPerm Yes Agency Only Yes boolean Only for updateAccountsand readAccounts. Allows the account to upload custom templates if set to 1.
defaultTemplates Yes Agency Only Yes boolean Only for updateAccountsand readAccounts. Allows the account to access the default templates we provide if set to 1.
enableInboxPreviews Yes Agency Only Yes boolean Only for updateAccountsand readAccounts. Gives the account the ability to purchase inbox previews if set to 1.
allowCustomizedBranding Yes Agency Only Yes boolean Only for updateAccountsand readAccounts. Allows the account to change the powered-by logo used in messages if set to 1.