Sub-Accounts allow for flexibility and additional security in the following ways:

1. Each Sub-Account has its own Suppression List.
2. Reports can be filtered by Sender, tracking email results per Sub-Account.
3. They can be assigned to different sending pools by our Deliverability team for greater flexibility.
4. Sub-Accounts allow for greater security by ensuring you don’t use your Master account credentials in SMTP transactions.
5. Setting up separate Sub-Accounts allows you to distinguish Emails by domain or to separate mailings between transactional and bulk email.

REST Methods

NOTE: API is case sensitive. Make all parameters entries lower case. All parameters in red are required.

VERB RESOURCE PARAMETERS DESCRIPTION
GET /accounts
  • apikey
  • startindex
Retrieves a list of up to 25 Email Sub-Accounts.
POST /accounts
  • apikey
  • username
  • password
  • accountname
  • companyname (Field deprecated)
  • phone (Field deprecated)
  • address (Field deprecated)
  • city (Field deprecated)
  • state (Field deprecated)
  • zipcode (Field deprecated)
  • country (Field deprecated)
  • timezone (Field deprecated)
  • bounceurl
  • spamurl
  • trackopens
  • tracklinks
  • trackunsubscribes
  • generatewapikey
Creates or updates an Email Sub-Account.
POST /accounts/delete
  • apikey
  • username
Deletes a Sub-Account.

 


GET /accounts

Retrieves a list of up to 25 Email Sub-Accounts.

Parameters

  • apikeyRequired. API key of the master account (Only the master account can have sub-accounts).
  • startindex — An integer to indicate the starting index of where to begin the list of sub-accounts. Defaults to 0, returning the first 25 sub-accounts. For accounts with a large number of sub-accounts, run the method multiple times, incrementing the start index by 25 for each iteration.

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"accounts":[{"username":"test_username1","apikey":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"username":"test_username2","apikey":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}…]}}

POST /accounts

Creates or updates an Email Sub-Account

Parameters

  • apikeyRequired. API key of the master account (Only the master account can create sub-accounts)
  • usernameRequired. Account username to be created — must be a valid email address, and must be unique amount all other sub-accounts
  • passwordRequired. Account password to be assigned. May be passed as clear text or MD5-encrypted with md5- as a prefix.
        Valid values and Examples:

    Clear text:

        Gat3keep3r!

    MD5-encrypted:

      md5-025656084871ac56716d3a9ae15c9e01
  • accountnameRequired. A unique string-based name for the account.
  • companynameRequired. Name of the company that the account is associated with.
  • phoneRequired. Phone number for the account.
  • address — Address
  • city(Field deprecated) City
  • state(Field deprecated) State
  • zipcode(Field deprecated) Zip
  • country(Field deprecated) Two-letter English abbreviation, based on the ISO 3166 standard
  • timezone(Field deprecated) The timezone of the account, in [+/-]h.mm format.
        Valid values and Examples:
        Eastern Time (USA/Canada): -5.00
      China/Hong Kong/Singapore: +8.00
  • bounceurl — Bounce Postback URL
  • spamurl — Spam Postback URL
  • trackopens — Toggle open tracking (1 or 0)
  • tracklinks — Toggle click tracking (1 or 0)
  • trackunsubscribes — Toggle automatic list-unsubscribe support (1 or 0)
  • generatenewapikey — Used to create a new API key for an existing account (1 or 0)

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"apikey":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}}

POST /accounts/delete

Deletes an Email Sub-Account.

Parameters

  • apikeyRequired. API key of the master account (Only the master account can create sub-accounts)
  • usernameRequired. Account username to be updated — must be a valid email address, and must be unique amount all other sub-accounts.

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":[]}}