PUT Exchange Mailing List

From Hostway API Documentation
Revision as of 07:40, 20 May 2013 by Mike.robski (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Edit an Exchange Mailing List

PUT /accounts/{account_number}/exchange/{domain_name}/mailingList/{mailing_list_name}

Contents

Parameters

account_number - string
The account-number that the Exchange resource belongs to
domain_name - string
The domain-name that is associated with the Exchange resource
mailing_list_name - string
The name of the specific mailing list

Request Body

 
{
  "name": "list1",
  "owner": "user1",
  "description": "desc"
} 
  
name - string
- The unique name of the mailing list. (Cannot be changed by the PUT request)
owner - string
- The mailbox username of the owner of the mailing list. (Cannot be changed by the PUT request)
description - string
- User defined description of the mailing list

Expected Response Codes

200
OK
400
Bad Request
404
Non-existent resource
405
Unsupported method
502
Internal server error

Example

PUT /accounts/dinh754963/exchange/ng-test-hwus-120120b.com/mailingList/test_list_a

- Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

- Request Body:

{"name" : "list1", "owner": "user1",  "description": "desc"} 

- Response: OK (204):

Server : nginx/0.6.32
Date : Thu, 10 May 2012 17:14:26 GMT
Content-Type : application/json
Connection : keep-alive
Content-Length : 0
Location : http://coreapi01.ote.chicago.hostway:8094/accounts/dinh754963/exchange/ng-test-dinh-123.com/mailingList/test_list_a/
  • There will be a Location header in the response pointing to the edited resource as shown above.
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox