Accounts-account-email-domain-webmail:PUT
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 87) |
Corinne.chui (Talk | contribs) m (1 revision) |
||
| (One intermediate revision by one user not shown) | |||
| Line 45: | Line 45: | ||
; 404 Not Found | ; 404 Not Found | ||
: The domain name does not exist. | : The domain name does not exist. | ||
| + | |||
| + | ; 409 Conflict | ||
| + | : Upgrade is disabled at the product level and cannot be turned on | ||
== Examples == | == Examples == | ||
Latest revision as of 13:36, 30 May 2016
PUT /accounts/{account}/email/{domain}/webmail
Change the OpenXchange allowUpgrade option.
Contents |
Request
PUT /accounts/{account}/email/{domain}/webmail
URI Parameters
- account - string
- domain - string
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
Request Body
{
"allowUpgrade": {allowUpgrade}
}
Parameters
- allowUpgrade - boolean
- OpenXchange allowUpgrade option value.
Response
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
Examples
Failure updating the domain settings without any options
Request
PUT /accounts/test/email/test.com/webmail
{}
Response
400 Bad Request
{"allowUpgrade": "Required"}
Success updating the allowUpgrade value
Request
PUT /accounts/test/email/test.com/webmail
{"allowUpgrade": true}
Response
204 No Content
