Mike.robski: 1 revision: Release 109

2015-07-24T18:15:51Z

1 revision: Release 109

Viktor.penkov: Created page with "= PUT accounts/{account}/email/{domain}/cleanmailplus = Updates domain's CleanMailPlus info. TOC == Request == `PUT accounts/{account}/email/{domain}/cleanmailplus<..."`


2015-05-19T12:53:55Z
Created page with "= PUT accounts/{account}/email/{domain}/cleanmailplus = Updates domain's CleanMailPlus info.  __TOC__  == Request == <code>PUT accounts/{account}/email/{domain}/cleanmailplus<..."
New page
= PUT accounts/{account}/email/{domain}/cleanmailplus =

Updates domain's CleanMailPlus info.



__TOC__



== Request ==

<code>PUT accounts/{account}/email/{domain}/cleanmailplus</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>

{

   "attributes": [

      {

         "attributeName": "{attribute_name}", 

         "attributeValue": "{attribute_value}"

      }

   ]

}

 </nowiki>





==== Parameters ====

; attributeName - ''string''

: Attribute's name.

; attributeValue - ''string''

: New attribute's value.



== Response ==



=== Status Code ===

; 204 No Content

: Success



; 400 Bad Request

: The format of the request body is invalid or the username 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 updating the CleanMailPlus filter attributes for a non-existent domain ===

'''Request'''

 <nowiki>

PUT accounts/{account}/email/non-existent-domain.com/cleanmailplus

{

    "attributes": [

       {

          "attributeName": "SPAM_LEVEL", 

          "attributeValue": "1"

       }

    ]

}

 </nowiki>



'''Response'''

 <nowiki>

404 Not Found

{

   "itemNotFound": {

      "message": "Resource not found", 

      "code": 404, 

      "details": {

         "message": "Domain not found"

      }

   }

}

 </nowiki>



=== Failure updating the CleanMailPlus filter attributes by providing bad request body ===

'''Request'''

 <nowiki>

PUT accounts/{account}/email/test.com/cleanmailplus

{

    "badBody":"badBodyValue"

}

 </nowiki>



'''Response'''

 <nowiki>

400 Bad Request

{

   "attributes": "Required"

}

 </nowiki>



=== Failure updating the cleanmailplus filter attribute by providing a non-existent attribute name ===

'''Request'''

 <nowiki>

PUT accounts/{account}/email/test.com/cleanmailplus

{

    "attributes": [

       {

          "attributeName": "NON_EXISTENT_ATTRIBUTE_NAME", 

          "attributeValue": "1"

       }

    ]

}

 </nowiki>



'''Response'''

 <nowiki>

400 Bad Request

{

   "attributes.0": "NON_EXISTENT_ATTRIBUTE_NAME is not valid filter attribute name"

}

 </nowiki>



=== Failure updating the cleanmailplus filter attribute by providing a non-valid attribute value ===

'''Request'''

 <nowiki>

PUT accounts/{account}/email/test.com/cleanmailplus

{

    "attributes": [

       {

          "attributeName": "SPAM_LEVEL", 

          "attributeValue": "val01"

       }

    ]

}

 </nowiki>



'''Response'''

 <nowiki>

400 Bad Request

{

   "attributes.0": "val01 is not valid attribute option for SPAM_LEVEL filter attribute"

}

 </nowiki>



=== Success updating the CleanMailPlus filter attributes ===

'''Request'''

 <nowiki>

PUT accounts/{account}/email/test.com/cleanmailplus

{

    "attributes": [

       {

          "attributeName": "SPAM_LEVEL", 

          "attributeValue": "1"

       }, 

       {

          "attributeName": "SPAM_ACTION", 

          "attributeValue": "1"

       }

    ]

}

 </nowiki>



'''Response'''

 <nowiki>

204 No Content

 </nowiki>





{{disqus}}

[[Category:Hostway API]]

[[Category:Email API]]

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

Mike.robski: 1 revision: Release 109

Viktor.penkov: Created page with "= PUT accounts/{account}/email/{domain}/cleanmailplus = Updates domain's CleanMailPlus info. __TOC__ == Request == PUT accounts/{account}/email/{domain}/cleanmailplus<..."

Viktor.penkov: Created page with "= PUT accounts/{account}/email/{domain}/cleanmailplus = Updates domain's CleanMailPlus info. TOC == Request == `PUT accounts/{account}/email/{domain}/cleanmailplus<..."`