Accounts-account-email-domain-blackwhitelist:PUT - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:14:10Z

1 revision: Release 109

Angel.dinev: /* Failure adding address with not valid address and type */

2015-04-16T12:49:45Z

Failure adding address with not valid address and type

Mike.robski: 1 revision: Release 103

2015-02-06T17:23:39Z

1 revision: Release 103

Mike.robski at 16:07, 6 February 2015

2015-02-06T16:07:07Z

New page

= PUT /accounts/{account}/email/{domain}/blackwhitelist =
Adding/updating addresses to black/white list for a specific domain

__TOC__

== Request ==
<code>PUT /accounts/{account}/email/{domain}/blackwhitelist</code>

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

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

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

=== Request Body ===
<nowiki>
{
"list":[
{
"address":"{address}",
"type":"{type}"
}
]
}
</nowiki>

==== Parameters ====
; address - ''string''
: Must be a valid email address. Required.

; type - ''string''
: One of W, B. Required.

== Response ==

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

; 400 Bad Request
: The format of the request body is invalid or the address 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 adding address with missing required parameter ===
'''Request'''
<nowiki>
PUT /accounts/account-number/email/test.com/blackwhitelist

{"list":[{"address":"mb1-white@somedomain.com"}]}
</nowiki>

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

{
"badRequest": {
"message": "POST data error",
"code": 400,
"details": {
"list.0.type": "Required"
}
}
}
</nowiki>

=== Failure adding address with not valid address and type ===
'''Request'''
<nowiki>
PUT /accounts/account-number/email/test.com/blackwhitelist

{"list":[{"address":"somedomain.com","type":"A"}]}
</nowiki>

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

{
"badRequest": {
"message": "POST data error",
"code": 400,
"details": {
"list.0.type": "\"A\" is not one of B, W",
"list.0.address": "Invalid email address in address: somedomain.com"
}
}
}
</nowiki>

=== Success adding addresses to black/white lists ===
'''Request'''
<nowiki>
PUT /accounts/account-number/email/test.com/blackwhitelist

{"list":[{"address":"mb1-white20150114-0113@somedomain.com", "type":"W"}, {"address":"mb2-white20150114-0113@somedomain.com", "type":"W"}] }
</nowiki>

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

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

@@ Line 33: / Line 33: @@
 ==== Parameters ====
 ; address - ''string''
-: Must be a valid email address. Required.
+: Must be a valid email or domain address. Required.
 ; type - ''string''
 : One of W, B. Required.
 == Response ==
@@ Line 98: / Line 97: @@
          "details": {
              "list.0.type": "\"A\" is not one of B, W",
-             "list.0.address": "Invalid email address in address: somedomain.com"
+             "list.0.address": "Invalid address format: somedomain.com"
+         }
+     }
@@ Line 104: / Line 103: @@
   </nowiki>
-=== Success adding addresses to black/white lists ===
+=== Success adding email addresses to blackwhitelist ===
 '''Request'''
   <nowiki>
@@ Line 115: / Line 114: @@
   <nowiki>
 No Content
   </nowiki>