Latest revision as of 14:36, 30 May 2016

[edit] GET /accounts/{account}/email/{domain}/webmail

Gets OpenXchange account type for the domain.

[edit] Request

GET /accounts/{account}/email/{domain}/webmail

[edit] URI Parameters

account - string

domain - string

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

Required. Set this header to application/json; charset=UTF-8

[edit] Response

[edit] Status Code

200 OK

Success

401 Unauthorized

The supplied credentials are invalid or do not provide permissions for this operation.

404 Not Found

The domain name does not exist.

[edit] Response Body

{
   "type": "{type}",
   "allowUpgrade": {allowUpgrade}
   "trialType": "{trialType}",
   "trialExpiration": "{trialExpiration}",
   "links": [
      {
         "location": "{APIBaseURL}/accounts/{account}/email/{domain}/webmail/", 
         "rel": "self"
      }
   ]
}
 

[edit] Parameters

type - string

Webmail account type. Supported values can be obtained from the webmailNames API endpoint.

allowUpgrade - boolean

Webmail allowUpgrade option value.

trialType - string - Can be null

Trial account type. Null if not set. Supported values can be obtained from the webmailNames API endpoint.

trialExpiration - date

Expiration date of trial period formatted as YYYY-mm-dd. Null if not set.

[edit] Examples

[edit] Success getting account type

Request

GET /accounts/test/email/test.com/webmail
 

Response

200 OK

{
   "type": "standard",
   "allowUpgrade": true,
   "trialType": "premium",
   "trialExpiration": "2018-10-28",
   "links": [
      {
         "location": "{APIBaseURL}/accounts/{account}/email/{domain}/webmail/", 
         "rel": "self"
      }
   ]
}