PUT Exchange Global Contact
From Hostway API Documentation
Revision as of 00:59, 2 July 2014 by Mike.robski (Talk | contribs)
Edit an Exchange Global Contact
PUT {server_name}/accounts/{account_number}/exchange/{domain_name}/globalContacts/{global_contact_id}
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
- global_contact_id - string
- The global-contact-id is the UUID of the global contact to be edited
Request Body
{
"target": "target@email.com",
"name": {
"name": "John Jello",
"company": "My Company",
"department": "Sales",
"title": "President"
},
"address": {
"address": "100 Main St.",
"city": "Chicago",
"state": "IL",
"zip": "60001",
"country": "US"
},
"phones": {
"homePhone": "87238473",
"businessPhone": "555-555-5501",
"fax": "555-555-5503",
"mobile": "555-555-5504"
},
"notes": "Notes in here"
}
- target - string
- (OPTIONAL)
- - A valid email address
- name - dictionary
- (OPTIONAL)
- - Contains additional personal details about the contact
- address - dictionary
- (OPTIONAL)
- - Contains additional address information about the contact
- phones - dictionary
- (OPTIONAL)
- - Contains additional information about the contact's phone numbers
Expected Response Codes
- 200
- OK
- 400
- Bad Request
- 404
- Non-existent resource
- 405
- Unsupported method
- 502
- Internal server error
Examples
PUT {server_name}/accounts/account300021/exchange/ng-test-hwus-120120b.com/globalContacts/00000136a1cbe0f216c8eec6000ae6fa2cb8a7d8
- Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
- Request Body:
{"target" : "testupdatedglobalcontact@test.com", "name" : {"name" : "First Last"}}
- Response: OK (204):
Server : nginx/0.6.32
Date : Wed, 11 Apr 2012 14:26:07 GMT
Content-Type : application/json; charset=UTF-8
Connection : keep-alive
Access-Control-Allow-Origin : *
Location : http://{server_name}/accounts/account300021/exchange/ng-test-hwus-120120b.com/globalContacts/00000136a1cbe0f216c8eec6000ae6fa2cb8a7d8/
Content-Length : 4
- There will be a Location header in the response pointing to the edited resource.
PUT {server_name}/accounts/account300021/exchange/ng-test-hwus-120120b.com/globalContacts/{non_existent_contact_id}
- Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
- Request Body:
{"target" : "testupdatedglobalcontact@test.com", "name" : {"name" : "First Last"}}
- Response: Not Found (404):
404 Not Found The resource could not be found.