POportsip
Administration

Create a dealer

Create a dealer.

post/dealers

Request

Request body

enabledboolean

Enable this dealer or not.

level'DISTRIBUTOR' | 'SUB_DISTRIBUTOR' | 'RESELLER' required

Dealer level includes:

  • DISTRIBUTOR: the first level of dealers.
  • SUB_DISTRIBUTOR: the second level of dealers.
  • RESELLER: the third level of dealers.
namestring required

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

passwordstring required

The password of dealer.

emailstring

The email address.

display_namestring

The display name of user.

websitestring

The website of user.

phonestring

The mobile phone number of user.

addressstring

The address.

descriptionstring

The description of dealer.

max_tenantsinteger required

The maximum number of tenants that the dealer is allowed to create.

max_extensionsinteger required

The maximum number of extensions that the dealer is allowed to create.

tenant_full_accessboolean

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Example request

{
  "email": "example@example.com"
}

Response

Success

idstring

The unique ID of the resource.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Changes

No recorded changes to this operation across all 1 revision of this API.