Customers Overview #
The Customers resource allows for the management of Customer tenants. The base URI for all request is:
/{VERSION}/customers/{CUSTOMER_TENANT_ID}
Customers Schema #
Customers represent a tenant on the system that end Users can be assigned to via the API.
| Key | Description | Type | Default | Required |
|---|---|---|---|---|
| id | The unique Customer identifier | string | (auto generated) | Yes (not create) |
| name | A short Customer name | string[100] | ||
| description | A longer descriptive name for the Customer | string[200] | ||
| reference | A service provider Customer reference | string[200] | ||
| dateCreated | The date and time the Customer was created | Datetime | ||
| parentTenantId | The id of the parent tenant | string | (auto generated) | |
| enabled | Indicates if this Customer is enabled. When a Customer is enabled the Pbx connection will be started and the email invitation sent out to each user with Website User access | boolean | false | |
| timezone | The default IANA timezone | string[40] | Inherited | |
| countryCode | The default country code using ISO 3166 standard | string[5] | Inherited | |
| features | Collection of licensed features | licensed features | Inherited | |
| pbxConnectionProfiles | The PBX configuration details | array(pbxConnectionProfile) | ||
| syncAcdAgentWithPbx1 | Indicates whether users should automatically be enabled for the ACD role if they are configured as an ACD agent on the PBX | boolean | false | |
| sendNewUserEmail | This controls whether the new users will be sent welcome emails or not. | boolean | true | |
| sendConnectWelcomeEmail | This controls whether new Connect client users will receive a welcome email or not. | boolean | true | |
| tenantProfileType2 | The id for the Tenant Profile which will be assigned to the customer | string | Inherited | |
| trialDuration1 | Indicates if the customer is trialling the system and if so for how many days | integer | 0 |
Licensed features #
| Key | Description |
|---|---|
| agent | Controls access to the ACD Agent Add-On role. 0 is disabled |
| device | Controls access to the Real-Time Client device license, i.e. FireTV client. 0 is disabled. |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all customers. |
| Get Customer | Returns a specific customer instance. |
| Create Customer | Creates a new customer instance. |
| Patch Customer | Updates an existing customer instance. |
| Delete Customer | Removes an existing customer instance. |
Customer Trials #
If available on your reseller account, the TrialDuration property can be used to allow a new customer to trial the Dimensions system. While trialling the system, no charges for the customer will be incurred.
The maximum duration permitted for the TrialDuration will differ by reseller. Please contact your Dimensions account manager for more information.
note
Passing 0 as the TrialDuration property will indicate that the customer is not trialling the system.
warning
If a customer is not terminated before the end of the trial period, they will start to be invoiced as a normal customer.
-
The SyncAcdAgentWithPBX & TrialDuration properties can only be set during the creation of a new customer and cannot be changed once the customer has been created. ↩︎
-
Ensure the correct Tenant Profile is used when creating a customer. Depending on the profile used, once assigned it may not be able to change it. ↩︎