Account v1.2

Account provides administrative information about your Sign-Up.to account.

This endpoint also has a partner-auth version.

What can I do with account?

Account provides administrative information, such as company details, credit balances, sub-user counts and list limits for an account.

  • Use list_count with list_limit to get total allowance for remaining lists.
  • Use emailcreditbalance, inboxtestcreditbalance or smscreditbalance to check how many of the respective credits your account holds.
  • Retrieve account details using address, telephone, website etc.

GET /account or /account/:id

AttributeTypeFilterSortDescription
id
intYes*Yes*Unique ID of the company account.
address
stringNoNoThe postal address for the company.
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.
country
stringNoNoCompany's country in ISO-3316-1 format (two character), for example "GB".
emailcreditbalance
intNoNoThe email credit balance for the account.
folder_count
intNoNoTotal number of folders in the account.
folderrestrict
boolNoNoWhether the account has folder restrictions enabled for sub-users (deprecated).
goaltrackingdomain
stringNoNoThis is the mail tracking domain which acts as the goal tracking domain.
inboxtestcreditbalance
intNoNoThe inbox test credit balance for the account.
list_count
intNoNoTotal number of lists in the account.
list_limit
intNoNoThe maximum number of lists that the account is allowed. Defaults to 200.
name
stringYes*Yes*Name of the company account.
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).
smscreditbalance
intNoNoThe SMS credit balance for the account.
subscriber_count
int/nullNoNoTotal number of email/sms subscribers in the account.
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. Defaults to null (unlimited).
telephone
string/nullNoNoThe telephone number for the company, including country dialling code.
timezone
stringNoNoThe Company's timezone in TZ (e.g. 'Europe/London') format. If not set, defaults to the Partner timezone.
user_count
intNoNoTotal number of sub-users that the account currently has setup.
user_limit
intNoNoTotal number of sub-users that the account can setup. Defaults to zero.
website
string/nullNoNoThe company website URL. Must be full URL starting with 'http'. Defaults to null.
cdate
decimalNoYes*Creation timestamp.
mdate
decimalNoNoLast modification timestamp

There is no filtering or sorting on this endpoint, as only one account record can ever be returned per company.

HEAD /account or /account/:id

While the HEAD method is supported, an account will always be present so it will return no useful information.

POST /account

This method is not supported.

PUT /account or /account/:id

This method is not supported.

DELETE /account or /account/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":                           12345,
    "address":                      "1 Companies Way, Companyville, Companyshire, AB12 3CD",
    "automation_limit":             100,
    "contactemail":                 "joe@example.com",
    "country":                      "GB",
    "custommaildomain":             true,
    "emailcreditbalance":           1000,
    "folder_count":                 5,
    "folderrestrict":               false,
    "goaltrackingdomain":           "http://sut1.co.uk/",
    "inboxtestcreditbalance":       10,  
    "list_count":                   20,
    "list_limit":                   100,
    "name":                         "Company X",
    "search_limit":                 10,
    "smsautomation_limit":          200,
    "smscreditbalance":             50,
    "subscriber_count":             10000,
    "subscriber_limit":             400,
    "subscriberprofilefield_limit": 30,
    "telephone":                    "442033552631",
    "timezone":                     "Europe/London",
    "user_count":                   3,
    "user_limit":                   5,
    "website":                      "http://www.company.com",
    "cdate":                        1234966741,
    "mdate":                        1234966741
}