Email-domain-usernames-mailboxName-webmail:POST
From Hostway API Documentation
Revision as of 06:05, 27 September 2013 by Stanimir.dimitrov (Talk)
POST /email/{domain}/usernames/{mailboxName}/webmail
Creates OpenXchange account.
Contents |
Request
POST /email/{domain}/usernames/{mailboxName}/webmail
URI Parameters
- domain - string
- mailboxName - string
Request Headers
- Authorization - HTTP Authorization header [1]
- Use the mailbox owner credentials for the specific mailbox, e.g. username: email@domain.com, password: secret
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8
Request Body
{
"type": "{oxtype}",
"allowUpgrade": {allowUpgrade}
}
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
POST /email/test.com/usernames/john.smith/webmail
{"type": "non-valid"}
Response
400 Bad Request
{"type": "\"non-existing\" is not one of standard, activesync, premium"}
Success creating account
Request
POST /email/test.com/usernames/john.smith/webmail
{"type": "activesync", "allowUpgrade": false}
Response
201 Created
