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

Mike.robski: 1 revision: Release 101

2014-12-17T04:50:55Z

1 revision: Release 101

Jerry.dimitrov: /* Status Code */

2014-11-26T14:28:08Z

Status Code

Mike.robski: 1 revision: Release 99

2014-10-14T15:08:43Z

1 revision: Release 99

Mike.robski: Moved the internal configuration comment to https://home.hostway/wiki/display/DevOps/MFG

2014-10-14T14:01:16Z

Moved the internal configuration comment to https://home.hostway/wiki/display/DevOps/MFG

Mike.robski: 1 revision: Release 98

2014-09-15T13:53:43Z

1 revision: Release 98

Dinh.anh: /* Status Code */

2014-09-02T11:28:24Z

Status Code

New page

= PUT /email/{domain}/usernames/{mailboxName}/secrets =
Set or update all secret questions and answers for mailbox(alias).
__TOC__

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

==== Request Parameters ====
; domain - ''string''
: The specific mailbox domain
; maiboxName - ''string''
: The name of the mailbox

=== Request Body ===
<nowiki>
{
"{tk}": "{answer}",
"{tk}": "{answer}",
...
}
</nowiki>

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

; answer - ''string'' (Required)
: The answer in plain-text - must be at least two characters.

=== Request Headers ===
{{Authorization}}

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

== Response ==

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

; 400 Bad Request
: The format of the request body is invalid or at least three pairs of secret questions and answers required.

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions for this operation.

; 404 Not Found
: The domain name, mailbox or account does not exist.

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/test-mailbox/secrets

{
"tk1": "answer1",
"tk2": "answer2",
"tk3": "answer3"
}
</nowiki>

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

=== Set only two secret questions and answers ===
'''Request'''
<nowiki>
PUT /email/test.com/usernames/test-mailbox/secrets

{
"tk1": "answer1",
"tk2": "answer2"
}
</nowiki>

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

"details": {"": "Shorter than minimum length 3"}
</nowiki>

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

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

@@ Line 40: / Line 40: @@
 ; 400 Bad Request
-: The format of the request body is invalid or at least three pairs of secret questions and answers required.
+: The format of the request body is invalid or the number of the secret questions and answers pairs in the request is lower then the [[Email-secretQuestionSettings:GET|required minimum]].
 ; 401 Unauthorized
@@ Line 70: / Line 70: @@
   </nowiki>
-=== Set only two secret questions and answers ===
+=== Set only two secret questions and answers, when the required minimum is three ===
 '''Request'''
   <nowiki>

@@ Line 27: / Line 27: @@
 ; answer - ''string'' (Required)
 : The answer in plain-text - must be at least two characters.
 === Request Headers ===
 {{Authorization}}