accountAllocations

The accountAllocations settings let you allocate features to accounts.

Overview

You can allocate things like emails, inbox previews, and additional users. 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.

Changing an account’s allocating features in excess of the defaults provided by the bundle type (only Advanced accounts can purchase add-ons) will cause extra costs to be incurred. Please be mindful of these additional charges when calling addAccounts or updateAccounts. For details on the cost you may accrue, contact your Account Manager.

Name Required for addAccountsAgency Only Required for updateAccounts Type Description
canExceedAllocation Yes No boolean Allows the account to exceed their allocated emails if set to 1.
canExceedSmsAllocation No No boolean Allows the account to exceed their allocated SMS if set to 1.
emails Yes No long The number of emails allocated to the account.
contacts Yes No long For advanced account types only. Used if you want to add-on to the default contact allocation and allocate more than the default 1,000,000 contacts. You can specify as many contacts as you like, but keep in mind that contacts are billed in bundles of 1M (1,000,000). For example, if you specify 2,000,001 contacts in the call, you will be billed for 3M contacts and receive 3M additional contacts.
Note: – This will cause additional costs to be incurred. Contact your account manager for pricing information.
hosting Yes No long For advanced account types only. Used if you want to add-on to the default hosting allocation and allocate more than the default 100 MB of hosting space. You must refer to the amount of hosting you would like to add in bytes (100MB = 104857600 bytes). You can specify as much hosting as you like, but keep in mind that hosting is billed in bundles of 200MB. For example, if you specify 210,763,776 (201MB) of hosting in the call, you will be billed for 400MB of hosting and receive 400MB of additional hosting, thus bringing your total to 501MB of hosting.
Note: – This will cause additional costs to be incurred. Contact your account manager for pricing information.
logins Yes No long For advanced account types only. Used if you want to add-on to the default users allocation and allocate more than the default 5 users for the account. You can purchase as many users as you like, but keep in mind that users are billed in bundles of 10. For example, if you specify 11 users in the call, you will be billed for 20 users and receive 20 additional users.
Note: – This will cause additional costs to be incurred. Contact your account manager for pricing information.
api Yes No boolean Gives API access to the account if set to 1.
fields Yes No long For advanced account types only. Used if you want to add-on to the default fields allocation and allocate more than the default 100 fields. You can purchase as many fields as you like, but keep in mind that fields are billed in bundles of 100. For example, if you specify 201 fields in the call, you will be billed for 300 fields and receive 300 additional fields.
Note: – This will cause additional costs to be incurred. Contact your account manager for pricing information.
startDate Yes No dateTime The date that the allocations begin on. Format should be YYYY-MM-DDThh:mm:ssTZD (e.g. 2009-07-16T19:20:30-05:00)
periodFrequency Yes Yes int The allocation period length in months (i.e How much time until the allocations are replenished). The valid values are 1, 3, 6, and 12.
bundle Yes Yes string The type of account you are adding. The valid values are professionaland core. For legacy agency accounts, you will need to use basic, intermediate, and advanced.
  • professional – Provides access to core email marketing features as well as an advanced feature set which includes: Automated Message Rules, Conversion Tracking, Direct Update, Connections, A/B splits, Advanced Reporting, and Dynamic Content. Professional accounts receive 5 users, 100MB of hosting, 100 fields, 1,000,000 contacts, 12 Inbox Previews, and API Access. Add-ons may also be purchased for Professional accounts, allowing you to further increase any of these allocations.
  • core – Provides access to core email marketing features. Core accounts receive 5 users, 100MB of hosting, 100 fields, and 1,000,000 contacts.
Legacy
  • Basic – Provides access to core email marketing features. Basic accounts receive 3 users, 10MB of hosting, 20 fields, and 20,000 contacts.
  • Intermediate – Provides access to core email marketing features as well as an advanced feature set which includes: Automated Message Rules, Conversion Tracking, Direct Update, Integrations, A/B splits, Advanced Reporting, and Dynamic Content.Intermediate accounts receive 5 users, 50MB of hosting, 50 fields, and 100,000 contacts.
  • Advanced – Provides access to core email marketing features as well as an advanced feature set which includes: Automated Message Rules, Conversion Tracking, Direct Update, Integrations, A/B splits, Advanced Reporting, and Dynamic Content. Advanced accounts receive 5 users, 100MB of hosting, 100 fields, and 1,000,000 contacts. Add-ons may also be purchased for Advanced accounts, allowing you to further increase any of these allocations.
defaultTemplates Yes No boolean Whether not the sub-account has access to the default templates we provide.