Accounts Overview (Enterprise) #
The Customers resource allows for the management of Reseller Account tenants. The base URI for all request is:
/{VERSION}/accounts/{ACCOUNT_TENANT_ID}
Accounts Schema #
Accounts represent a tenant on the system that end Users can be assigned to via the API.
| Key | Description | Type | Default | Required |
|---|---|---|---|---|
| id | The unique account identifier | string | (auto generated) | Yes (not create) |
| name | A short account name | string[100][100] | ||
| description | A longer descriptive name for the account | string[200][200] | ||
| reference | A service provider account reference | string[200][200] | ||
| dateCreated | The date and time the Customer was created | Datetime | ||
| parentTenantId1 | The id of the parent tenant | string | (auto generated) | |
| enabled | Indicates if this account is enabled. When an account is enabled, email invitations will be sent out to each user with Website access | boolean | false | |
| timezone | The default IANA timezone | string[40][40] | Inherited | |
| countryCode | The default country code using ISO 3166 standard | string[5][5] | Inherited | |
| dateDeleted | The date the account was deleted | boolean | false |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all accounts. |
| Get Reseller Account | Returns a specific reseller account instance. |
| Create Reseller Account | Creates a new reseller account instance. |
| Patch Reseller Account | Updates an existing reseller account instance. |
| Delete Reseller Account | Removes an existing reseller account instance. |
| Reseller Account Metrics | Returns licence metrics for a reseller account instance. |
-
The service providers enterprise level ID. ↩︎