Accounts-account-email-domain-webmail:PUT

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision)
 

Latest revision as of 14:36, 30 May 2016

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

Change the OpenXchange allowUpgrade option.

Contents


[edit] Request

PUT /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] Request Body

{
    "allowUpgrade": {allowUpgrade}
}
 


[edit] Parameters

allowUpgrade - boolean
OpenXchange allowUpgrade option value.

[edit] Response

[edit] Status Code

204 No Content
400 Bad Request
The format of the request body is invalid or the username does not meet the requirements.
401 Unauthorized
The supplied credentials are invalid or do not provide permissions for this operation.
404 Not Found
The domain name does not exist.
409 Conflict
Upgrade is disabled at the product level and cannot be turned on

[edit] Examples

[edit] Failure updating the domain settings without any options

Request

PUT /accounts/test/email/test.com/webmail

{}
 

Response

400 Bad Request

{"allowUpgrade": "Required"}
 

[edit] Success updating the allowUpgrade value

Request

PUT /accounts/test/email/test.com/webmail

{"allowUpgrade": true}
 

Response

204 No Content


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox