Mike.robski: 1 revision: Release 101

2014-12-17T04:50:56Z

1 revision: Release 101

Jerry.dimitrov at 14:13, 4 December 2014

2014-12-04T14:13:39Z

New page

= POST {{{base}}}/email/{domain}/usernames/{mailboxName}/{{{resource}}}/action =
Apply an action on{{{2}}}{{{1}}} mailbox e.g. '''reset password'''

__TOC__

== Request ==
<code>POST {{{base}}}/email/{domain}/usernames/{mailboxName}/{{{resource}}}/action</code>

==== Request Parameters ====
; account - ''string''
: The user account owning the domain and the{{{1}}} mailboxes
; domain - ''string''
: The specific domain for which the call will retrieve the list
; maiboxName - ''string''
: The name of the{{{1}}} mailbox.

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

=== Request Body ===
<nowiki>
{
"action": "resetPassword",
"actionData": {
"secretQuestionsAnswers": {"{tk}": "{answer}"},
"password": "{password}"
}
}
</nowiki>

; action - ''string''
: The action that should be performed. Allowed values are:
:: '''resetPassword''' - Reset the password of{{{2}}}{{{1}}} mailbox.

; actionData - ''dictionary (Required)''
: Data to be send with the action.

; secretQuestionsAnswers - ''dictionary (Required)''
: Dictionary of key/value pairs, each of which represents '''secret question text key/answer''' pair.

; tk - ''string'' (Required)
: The text key for the secret question. There should be no duplicate text keys per{{{1}}} mailbox.

; answer - ''string'' (Required)
: The answer in plain-text - must be at least two characters.
{{:Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT}}

== Response ==

=== Expected Response Codes ===
; 204 No Content
: Success

; 400 Bad Request
: The supplied action or the supplied data is invalid.

; 404 Not Found
: The resource does not exist.

; 409 Conflict
: Validation of the secret answer failed.

== Examples ==

=== Request password reset of{{{2}}}{{{1}}} mailbox ===
'''Request'''
<nowiki>
POST </nowiki>{{{base_example}}}<nowiki>/email/test.com/usernames/mailbox123/</nowiki>{{{resource}}}<nowiki>/action
Content-Type: application/json; Charset=UTF-8

{
"action": "resetPassword",
"actionData": {
"secretQuestionsAnswers": {"tk1": "answer123"},
"password": "pWord123$"
}
</nowiki>

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

=== Request password reset of{{{2}}}{{{1}}} mailbox with wrong answer ===
'''Request'''
<nowiki>
POST </nowiki>{{{base_example}}}<nowiki>/email/test.com/usernames/mailbox123/</nowiki>{{{resource}}}<nowiki>/action
Content-Type: application/json; Charset=UTF-8

{
"action": "resetPassword",
"actionData": {
"secretQuestionsAnswersList": {"tk1": "wrongAnswer"},
"password": "pWord123$"
}
</nowiki>

'''Response'''
<nowiki>
409 Conflict

{
"conflict": {
"message": "Invalid secret questions and answers provided",
"code": 409,
}
}
</nowiki>

== See also ==
* [[Email API|Email API]]

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

Template:ResetPassword - Revision history

Mike.robski: 1 revision: Release 101

Jerry.dimitrov at 14:13, 4 December 2014