AccountFeatures v1.2

Provides an overview of features available to an account.

This endpoint applies to partner-auth only. See our guide for more information on partner-auth endpoints and authentication.

This endpoint also has a company-auth version.

What can I do with accountFeatures?

AccountFeatures details the features and settings in an account and allows modification to these settings.

  • Useful for third-party applications/integrations.
  • Issue a PUT on accountFeatures to customise the functionality available to an account.

GET /accountFeatures or /accountFeatures/:id

AttributeTypeFilterSortDescription
id
intNoNoUnique ID of the company account.
automation_limit
int/nullNoNoThe maximum number of automations that the account is allowed. Defaults to null (unlimited).
contactemail
stringNoNoThe contact email address for the account.
custommaildomaintype
string/nullNoNoIf the account is using a custom sending email address or domain, the type of domain i.e. 'fixed_email' or 'domain'. Will be null if 'enablecustommaildomain' is false. Defaults to 'fixed_email' otherwise.
enableanalyse
boolNoNoWhether the account has Analysis tools enabled. Defaults to false.
enableaudienceinsights
boolNoNo

Whether the account can use the Audience Insights feature. Defaults to true.

enablechangepassword
boolNoNoWhether the account users can change their passwords. Defaults to true.
enablecustommaildomain
boolNoNoWhether the account uses a custom sending email address / domain. Defaults to false.
enabledkim
boolNoNoWhether the account has DomainKeys Identified Mail (DKIM) enabled. Defaults to true.
enabledynamiccontent
boolNoNoWhether the account has Dynamic Content enabled. Defaults to false.
enableemail
boolNoNoWhether the account has email feature set. Defaults to true.
enableemailcredits
boolNoNoWhether the account uses email credits. Defaults to true.
enablefacebook
boolNoNoWhether the account can integrate with Facebook. Defaults to false.
enablehttppmapi
boolNoNoWhether the account has PMAPI access enabled over HTTP. Defaults to true.
enableinboxtest
boolNoNoWhether the account can run inbox tests. Defaults to false.
enablesalesforce
boolNoNoWhether the account has Salesforce integration enabled. Defaults to true.
enablesendbulkemail
boolNoNoWhether the account can send bulk email campaigns. Defaults to true.
enablesendbulksms
boolNoNoWhether the account can send bulk SMS campaigns. Defaults to true.
enablesms
boolNoNoWhether the account has SMS feature set. Defaults to true.
enablesplittest
bool/nullNoNoWhether the account can run split tests. Will only be non-null if 'enablesendbulkemail' is true. Defaults to false.
enablesubscriberprofilefields
boolNoNoWhether the account has Subscriber Profile Fields enabled. Defaults to true.
enablesubscriptionmo
bool/nullNoNoWhether the account can accept subscriptions via inbound SMS (MO). Will only be non-null if 'enablesms' is true. Defaults to true.
enabletimezonepremium
boolNoNoWhether Timezone Premium features are enabled for the account. Defaults to false.
enabletwitter
boolNoNoWhether the account can integrate with Twitter. Defaults to false.
enablewordpress
boolNoNoWhether the account can integrate with Wordpress. Defaults to false.
list_limit
intNoNoThe maximum number of lists that the account is allowed. Defaults to 200.
locked
boolNoNoWhether the account is locked (users cannot access the account or make PM API calls).
maildomainprimary
string/nullNoNoThe primary custom sending email address or domain. Will be null if 'enablecustommaildomain' is false.
search_limit
int/nullNoNoThe maximum number of searches that the account is allowed. Defaults to null (unlimited).
smsautomation_limit
int/nullNoNoThe maximum number of SMS automations that the account is allowed. Defaults to null (unlimited).
subscriber_limit
int/nullNoNoThe maximum number of subscribers that the account is allowed. Defaults to null (unlimited). The minimum value is 1.
subscriberprofilefield_limit
int/nullNoNoThe maximum number of subscriber profile fields that the account is allowed. Can only be non-null if 'enablesubscriberprofilefields' is true. Defaults to null (unlimited).
timezone
stringNoNoThe Company's timezone in TZ (e.g. 'Europe/London') format. If not set, defaults to the Partner timezone.
user_limit
intNoNoTotal number of sub-users that the account can setup.
cdate
decimalNoNoCreation timestamp.
mdate
decimalNoNoLast modification timestamp.

HEAD /accountFeatures or /accountFeatures/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the company account.

POST /accountFeatures

This method is not supported.

PUT /accountFeatures or /accountFeatures/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the company account.
automation_limit
int/nullOptionalThe maximum number of automations that the account is allowed. Defaults to null (unlimited).
contactemail
stringOptionalThe contact email address for the account.
custommaildomaintype
string/nullOptional*If the account is using a custom sending email address or domain, the type of domain i.e. 'fixed_email' or 'domain'. Will be null if 'enablecustommaildomain' is false. Defaults to 'fixed_email' otherwise.
enableanalyse
boolOptionalWhether the account has Analysis tools enabled. Defaults to false.
enableaudienceinsights
boolOptional

Whether the account can use the Audience Insights feature. Defaults to true.

enablechangepassword
boolOptionalWhether the account users can change their passwords. Defaults to true.
enablecustommaildomain
boolOptionalWhether the account uses a custom sending email address / domain. Defaults to false.
enabledkim
boolOptionalWhether the account has DomainKeys Identified Mail (DKIM) enabled. Defaults to true.
enabledynamiccontent
boolOptionalWhether the account has Dynamic Content enabled. Defaults to false.
enableemail
boolOptionalWhether the account has email feature set. Defaults to true.
enableemailcredits
boolOptionalWhether the account uses email credits. Defaults to true.
enablefacebook
boolOptionalWhether the account can integrate with Facebook. Defaults to false.
enablehttppmapi
boolOptionalWhether the account has PMAPI access enabled over HTTP. Defaults to true.
enableinboxtest
boolOptionalWhether the account can run inbox tests. Defaults to false.
enablesalesforce
boolOptionalWhether the account has Salesforce integration enabled. Defaults to true.
enablesendbulkemail
boolOptionalWhether the account can send bulk email campaigns. Defaults to true.
enablesendbulksms
boolOptionalWhether the account can send bulk SMS campaigns. Defaults to true.
enablesms
boolOptionalWhether the account has SMS feature set. Defaults to true.
enablesplittest
bool/nullOptional**Whether the account can run split tests. Will only be non-null if 'enablesendbulkemail' is true. Defaults to false.
enablesubscriberprofilefields
boolOptionalWhether the account has Subscriber Profile Fields enabled. Defaults to true.
enablesubscriptionmo
bool/nullYes****Whether the account can accept subscriptions via inbound SMS (MO). Will only be non-null if 'enablesms' is true. Defaults to true.
enabletimezonepremium
boolOptionalWhether Timezone Premium features are enabled for the account. Defaults to false.
enabletwitter
boolOptionalWhether the account can integrate with Twitter. Defaults to false.
enablewordpress
boolOptionalWhether the account can integrate with Wordpress. Defaults to false.
list_limit
intOptionalThe maximum number of lists that the account is allowed. Defaults to 200.
locked
boolOptionalWhether the account is locked (users cannot access the account or make PM API calls).
maildomainprimary
string/nullOptional*The primary custom sending email address or domain. Will be null if 'enablecustommaildomain' is false.
search_limit
int/nullOptionalThe maximum number of searches that the account is allowed. Defaults to null (unlimited).
smsautomation_limit
int/nullOptionalThe maximum number of SMS automations that the account is allowed. Defaults to null (unlimited).
subscriber_limit
int/nullOptionalThe maximum number of subscribers that the account is allowed. Defaults to null (unlimited). The minimum value is 1.
subscriberprofilefield_limit
int/nullOptional***The maximum number of subscriber profile fields that the account is allowed. Can only be non-null if 'enablesubscriberprofilefields' is true. Defaults to null (unlimited).
timezone
stringOptionalThe Company's timezone in TZ (e.g. 'Europe/London') format. If not set, defaults to the Partner timezone.
user_limit
intOptionalTotal number of sub-users that the account can setup.

* Can only be set if enablecustommaildomain is true.

** Can only be set if enablesendbulkemail is true.

*** Can only be set if enablesubscriberprofilefields is true.

**** Can only be set if enablesms is true.

DELETE /accountFeatures or /accountFeatures/:id

This method is not supported.

Examples

JSON response

{
    "id":                            12345,
    "automation_limit":              100,
    "contactemail":                  "joe@example.com",
    "custommaildomaintype":          "fixed_email",
    "enableanalyse":                 true,
    "enableaudienceinsights":        true,
    "enablechangepassword":          true,
    "enablecustommaildomain":        true,
    "enabledkim":                    true,
    "enabledynamiccontent":          false,
    "enableemail":                   true,
    "enableemailcredits":            true,
    "enablefacebook":                true,
    "enablehttppmapi":               true,
    "enableinboxtest":               true,
    "enablesalesforce":              true,
    "enablesendbulkemail":           true,
    "enablesendbulksms":             false,
    "enablesms":                     false,
    "enablesplittest":               true,
    "enablesubscriberprofilefields": true,
    "enablesubscriptionmo":          true,
    "enabletimezonepremium":         false,
    "enabletwitter":                 false,
    "enablewordpress":               false,  
    "list_limit":                    100,
    "locked":                        false,
    "maildomainprimary":             "example@example.com",
    "search_limit":                  10,
    "smsautomation_limit":           200,
    "subscriber_limit":              400,
    "subscriberprofilefield_limit":  30,
    "timezone":                      "Europe/London",
    "user_limit":                    5,
    "cdate":                         1234966741,
    "mdate":                         1234966741
}