Accounts-account-email-domain-webmailUpgrade:GET

Jerry.dimitrov (Talk)
(→Response)
Newer edit →

---

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

Retrieves the product level upgrade configuration

Note: /email/{domain}/webmailUpgrade is a shortcut equivalent of this resource

Request

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

URI Parameters

account - string

Account number for the owner of the email domain entity.

domain - string

Target domain name of the email domain resource.

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

Response

Returns dictionary which contains the webmail upgrade settings for the target domain as a key-value pairs.

Status Code

200 OK

Success

Response Body

{
   "allowed": false,
   "links": [
      {
         "href": "https://api.hostway.com/accounts/accNum123/email/example.com/webmailUpgrade/", 
         "rel": "self"
      }
   ]
}
  

Parameters

allowed - boolean

Whether upgrades are enabled or disabled by the product

links - list

Hypermedia for the resource.

See also

• Email API
• Common Features

blog comments powered by Disqus