Account and User Methods

Overview

An Account includes all of the data about your system including details about the Account settings, the Account Owner, privileges, and Message limits.

A sub-Account is an Account that a Reseller provides to a customer. Sub-Accounts may contain their own sub-Accounts. Depending on the Account settings, a sub-Account may have access to its parent Account and/or access to its sub-Accounts.

Users (also referred to as User Accounts) represent individuals assigned to the Account. The User who owns the Account, the Account Owner, is the administrator, and has the ability to create Users and set User privileges and Message limits. The Account Owner cannot be deleted.

Account Methods

• acceptTermsAndConditions

  Accepts terms and conditions for an Account you are creating through the API.

• addAccount

  Creates a new Account and an Account Owner.

• approveTrialAccount

  Upgrades an Account from trial status to paid status.

• countAccounts

  Returns the sum of Accounts that match search criteria.

• deactivateAccount

  Makes the Account inaccessible to all Users.

• deleteAccount

  Permanently deletes an Account.

• editAccount

  Edits an existing Account.

• getAccountById

  Gets information about an Account.

• getTermsAndConditions

  Gets terms and conditions key for an Account you are creating through the API.

• reactivateAccount

  Reactivates a deactivated Account, making it accessible to Users again.

• searchAccounts

  Returns data for all Accounts or for Accounts that match search criteria.

User Methods

• addUser

  Adds a new User Account.

• countUsers

  Returns the total number of Users or the number of Users that match search criteria.

• deleteUser

  Permanently deletes a User from the system.

• editUser

  Edits a User Account.

• getUserById

  Returns data about the specified User.

• searchUsers

  Returns data about all Users or about Users who match search criteria.