Email-domain-usernames-mailboxName-webmail:PUT - Revision history

Corinne.chui: 1 revision

2016-05-30T19:36:05Z

1 revision

Dragomir.penev at 14:10, 16 May 2016

2016-05-16T14:10:36Z

Mike.robski: 1 revision: Release 95

2014-07-02T05:58:44Z

1 revision: Release 95

Velimira.metodieva: /* Parameters */

2014-06-17T13:31:45Z

Parameters

Mike.robski: 1 revision: Release 93

2014-05-08T07:35:53Z

1 revision: Release 93

Velimira.metodieva: /* Success updating account type */

2014-03-28T10:49:16Z

Success updating account type

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:22Z

1 revision: Release 87

Stanimir.dimitrov: moved Email-domain-usernames-mailbox-webmail:PUT to Email-domain-usernames-mailboxName-webmail:PUT

2013-09-27T12:05:49Z

moved Email-domain-usernames-mailbox-webmail:PUT to Email-domain-usernames-mailboxName-webmail:PUT

New page

= PUT /email/{domain}/usernames/{mailboxName}/webmail =
Upgrades/downgrades OpenXchange account type.

__TOC__

== Request ==
<code>PUT /email/{domain}/usernames/{mailboxName}/webmail</code>

=== URI Parameters ===
; domain - ''string''
:
; mailboxName - ''string''
:

=== Request Headers ===
{{EmailApiAuthorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"type": "{type}",
"allowUpgrade": {allowUpgrade}
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value
; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type. Valid values are standard, activesync, premium. Required.
: If allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response
: If type is already different than standard and allowUpgrade is set to false the response is ''400 Bad Request''

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 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.

== Examples ==

=== Failure updating account type with empty type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": ""}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "Required"}
</nowiki>

=== Failure updating account type with invalid type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "invalid-type"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"type": "\"invalid-type\" is not one of standard, activesync, premium"}
</nowiki>

=== Failure using inconsistent combination of allowUpgrade and type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "premium", "allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "The allowUpgrade option is inconsistent with the provided type"}
</nowiki>

=== Failure changing the allowUpgrade option for activesync or premium accounts ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"allowUpgrade": false}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "The account is already upgraded. Please downgrade it to standard first."}
</nowiki>

=== Failure when upgrading the account while allowUpgrade is set to false ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "premium"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"message": "This account is not allowed to be upgraded"}
</nowiki>

=== Success updating account type ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/john.smith/webmail

{"type": "premium"}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 33: / Line 33: @@
 ==== Parameters ====
 ; allowUpgrade - ''boolean''
-: OpenXchange allowUpgrade option value
+: OpenXchange allowUpgrade option value. If upgrades are disabled by the product, it cannot be set to true.
-; type - ''string'' - one of "standard", "activesync" or "premium"
+; type - ''string'' ''(Required)''
-: OpenXchange account type. Valid values are standard, activesync, premium. Required.
+: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]].
-: If allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response
+: The account owner(with admin-user credentials) can make changes between account types regardless of the allowUpgrade settings.
-: If type is already different than standard and allowUpgrade is set to false the response is ''400 Bad Request''
+: If the call is made with the end-user credentials and allowUpgrade is set to ''false'' providing a type different than standard results in a ''400 Bad Request'' response
 : If current usage is more than new type quota the response is ''400 Bad Request''
 : If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
 ; theme - ''string''
 : Theme identifier for setting a specific theme when creating an OX account.

@@ Line 23: / Line 23: @@
+{
      "type": "{type}",
-     "allowUpgrade": {allowUpgrade}
+     "allowUpgrade": {allowUpgrade},
+}
   </nowiki>
@@ Line 36: / Line 39: @@
 : If type is already different than standard and allowUpgrade is set to false the response is ''400 Bad Request''
 : If current usage is more than new type quota the response is ''400 Bad Request''
 == Response ==
@@ Line 114: / Line 124: @@
   </nowiki>
-=== Failure when upgrading the account while allowUpgrade is set to false ===
+=== Failure upgrading account while allowUpgrade is set to false ===
 '''Request'''
   <nowiki>
@@ Line 127: / Line 137: @@
 {"message": "This account is not allowed to be upgraded"}
   </nowiki>
@@ Line 142: / Line 167: @@
 </nowiki>
-=== Failure when downgrading the account due to current usage greater than new quota ===
+=== Failure downgrading account due to current usage greater than new quota ===
 '''Request'''
   <nowiki>
@@ Line 156: / Line 181: @@
 {"message": "Current mailbox usage is larger than the new quota value"}
   </nowiki>
 {{disqus}}
 [[Category:Hostway API]]
 [[Category:Email API]]