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

Corinne.chui: 1 revision

2016-05-30T19:36:05Z

1 revision

Jerry.dimitrov: /* Parameters */

2016-05-09T13:40:05Z

Parameters

Mike.robski: 1 revision: Release 95

2014-07-02T05:58:44Z

1 revision: Release 95

Velimira.metodieva: /* Failure creating account when mailbox qty for OX type is exceeded */

2014-06-17T13:28:45Z

Failure creating account when mailbox qty for OX type is exceeded

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:20Z

1 revision: Release 87

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

2013-09-27T12:05:32Z

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

New page

= POST /email/{domain}/usernames/{mailboxName}/webmail =
Creates OpenXchange account.

__TOC__

== Request ==
<code>POST /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": "{oxtype}",
"allowUpgrade": {allowUpgrade}
}
</nowiki>

==== Parameters ====
; allowUpgrade - ''boolean''
: OpenXchange allowUpgrade option value. The default value is true.
; type - ''string'' - one of "standard", "activesync" or "premium"
: OpenXchange account type. Valid values are standard, activesync, premium. If not provided - standard is default.

== Response ==

=== Status Code ===
; 201 Created
: Success

; 400 Bad Request
: The format of the request body is invalid or the OpenXchange account type does not meet the requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 409 Conflict
: OpenXchange account already exists.

; 404 Not Found
: The domain name or mailbox do not exist.

== Examples ==

=== Failure creating account with not-valid parameter ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

{"type": "non-valid"}
</nowiki>

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

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

=== Success creating account ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/john.smith/webmail

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

'''Response'''
<nowiki>
201 Created
</nowiki>

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

@@ Line 34: / Line 34: @@
 ; allowUpgrade - ''boolean''
 : OpenXchange allowUpgrade option value. The default value is true.
-; type - ''string'' - one of "standard", "activesync" or "premium"
+; type - ''string''
-: OpenXchange account type. Valid values are standard, activesync, premium. If not provided - standard is default.
+: OpenXchange account type. Supported values can be obtained from the [[Accounts-account-email-domain-webmailNames:GET|webmailNames API endpoint]]. If not provided - standard is default.
 : If current mailbox qty is more than allowed for specific OpenXchange account type the response is ''400 Bad Request''
 ; theme - ''string''

@@ Line 23: / Line 23: @@
+{
      "type": "{oxtype}",
-     "allowUpgrade": {allowUpgrade}
+     "allowUpgrade": {allowUpgrade},
+}
   </nowiki>
@@ Line 33: / Line 36: @@
 ; type - ''string'' - one of "standard", "activesync" or "premium"
 : OpenXchange account type. Valid values are standard, activesync, premium. If not provided - standard is default.
 == Response ==
@@ Line 67: / Line 77: @@
 {"type": "\"non-existing\" is not one of standard, activesync, premium"}
   </nowiki>
@@ Line 74: / Line 99: @@
 POST /email/test.com/usernames/john.smith/webmail
-{"type": "activesync", "allowUpgrade": false}
+{"type": "activesync", "allowUpgrade": false, "language": "en_US", "timezone": "America/Chicago"}
   </nowiki>