Account Endpoint | Sign-Up.to Permission Marketing API

Account v1.2

Account provides administrative information about your Sign-Up.to 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 account?

Account can be used to create new accounts and retrieve administrative information, such as company details, credit balances, sub-user counts and list limits for existing accounts.

Issue a POST to create a new account and use the various optional limit attributes to manage the features available to the 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 the account holds.
Retrieve account contact details using address, telephone, website etc.

GET /account or /account/:id

Attribute	Type	Filter	Sort	Description
id	int	Yes*	Yes*	Unique ID of the company account.
address	string	No	No	The postal address for the company.
automation_limit	int/null	No	No	The maximum number of automations that the account is allowed. Defaults to null (unlimited).
contactemail	string	No	No	The contact email address for the account.
country	string	No	No	Company's country in ISO-3316-1 format (two character), for example "GB".
emailcreditbalance	int	No	No	The email credit balance for the account.
folder_count	int	No	No	Total number of folders in the account.
folderrestrict	bool	No	No	Whether the account has folder restrictions enabled for sub-users (deprecated).
goaltrackingdomain	string	No	No	This is the mail tracking domain which acts as the goal tracking domain.
inboxtestcreditbalance	int	No	No	The inbox test credit balance for the account.
list_count	int	No	No	Total number of lists in the account.
list_limit	int	No	No	The maximum number of lists that the account is allowed. Defaults to 200.
name	string	Yes*	Yes*	Name of the company account.
search_limit	int/null	No	No	The maximum number of searches that the account is allowed. Defaults to null (unlimited).
smsautomation_limit	int/null	No	No	The maximum number of SMS automations that the account is allowed. Defaults to null (unlimited).
smscreditbalance	int	No	No	The SMS credit balance for the account.
subscriber_count	int/null	No	No	Total number of email/sms subscribers in the account.
subscriber_limit	int/null	No	No	The maximum number of subscribers that the account is allowed. Defaults to null (unlimited). The minimum value is 1.
subscriberprofilefield_limit	int/null	No	No	The maximum number of subscriber profile fields that the account is allowed. Defaults to null (unlimited).
telephone	string/null	No	No	The telephone number for the company, including country dialling code.
timezone	string	No	No	The Company's timezone in TZ (e.g. 'Europe/London') format. If not set, defaults to the Partner timezone.
user_count	int	No	No	Total number of sub-users that the account currently has setup.
user_limit	int	No	No	Total number of sub-users that the account can setup. Defaults to zero.
website	string/null	No	No	The company website URL. Must be full URL starting with 'http'. Defaults to null.
cdate	decimal	No	Yes*	Creation timestamp.
mdate	decimal	No	No	Last modification timestamp

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

Attribute	Type	Presence	Description
address	string	Required	The postal address for the company.
contactemail	string	Required	The contact email address for the account.
country	string	Required	Company's country in ISO-3316-1 format (two character), for example "GB".
list_limit	int	Optional	The maximum number of lists that the account is allowed. Defaults to 200.
name	string	Required	Name of the company account.
search_limit	int/null	Optional	The maximum number of searches that the account is allowed. Defaults to null (unlimited).
smsautomation_limit	int/null	Optional	The maximum number of SMS automations that the account is allowed. Defaults to null (unlimited).
subscriber_limit	int/null	Optional	The maximum number of subscribers that the account is allowed. Defaults to null (unlimited). The minimum value is 1.
subscriberprofilefield_limit	int/null	Optional	The maximum number of subscriber profile fields that the account is allowed. Defaults to null (unlimited).
telephone	string/null	Optional	The telephone number for the company, including country dialling code.
timezone	string	Optional	The Company's timezone in TZ (e.g. 'Europe/London') format. If not set, defaults to the Partner timezone.
user_limit	int	Optional	Total number of sub-users that the account can setup. Defaults to zero.
website	string/null	Optional	The company website URL. Must be full URL starting with 'http'. Defaults to null.

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
}