Latest revision as of 16:24, 15 November 2013

PUT /accounts/{account}/email/{domain}/contacts/{contact}

Updates domain's global address book contact info

Request

PUT /accounts/{account}/email/{domain}/contacts/{contact}

URI Parameters

account - string

domain - string

contact - string

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

Required. Set this header to application/json; charset=UTF-8

Request Body

{
    "email": "{email}", 
    "firstName": "{firstName}", 
    "lastName": "{lastName}", 
    "displayName": "{displayName}"
    "title": "{title}",
    "homePhone": "{homePhone}",
    "mobilePhone": "{mobilePhone}",
    "businessPhone": "{businessPhone}",
    "businessFax": "{businessFax}",
    "isdnNumber": "{isdnNumber}",
    "pager": "{pager}",
    "telexNumber": "{telexNumber}",
    "company": "{company}",
    "department": "{department}",
    "roomNumber": "{roomNumber}",
    "streetAddress": "{streetAddress}",
    "postalCode": "{postalCode}",
    "city": "{city}",
    "state": "{state}",
    "country": "{country}"
}
 

Parameters

email - string

The email of global address book contact.

firstName - string

The first name of global address book contact.

lastName - string

The last name of global address book contact.

displayName - string

The display name of global address book contact.

title - string

The title of global address book contact person.

homePhone - string

The home phone of global address book contact.

mobilePhone - string

The home phone of global address book contact.

businessPhone - string

The business phone of global address book contact.

businessFax - string

The business fax of global address book contact.

isdnNumber - string

The isdn number of global address book contact.

pager - string

The pager of global address book contact.

telexNumber - string

The telex number of global address book contact.

company - string

The company name of global address book contact.

department - string

The department name of global address book contact.

roomNumber - string

The room number of global address book contact.

streetAddress - string

The street address of global address book contact.

postalCode - string

The postal code of global address book contact.

city - string

The city name of global address book contact.

state - string

The state name of global address book contact.

country - string

The country name of global address book contact.

Response

Status Code

204 No Content

Success

400 Bad Request

The format of the request body is invalid or the parameters don't meet the requirements.

401 Unauthorized

The supplied credentials are invalid or do not provide permissions for this operation.

Examples

Failure updating global address book contact because of erroneous data

Request

PUT https://api.hostway.com/accounts/account007/email/test-domain.com/contacts/test-contact

{
    "email": "updated-email", 
    "displayName": "Display Name Updated"
}
 

Response

400 Bad Request

{
    "email": "Invalid email address"
}
 

Success updating global address book contact

Request

PUT https://api.hostway.com/accounts/account007/email/test-domain.com/contacts/test-contact

{
    "email": "new@test.com", 
    "mobilePhone": "123456789"
}
 

Response

204 No Content
 

See also

• Global Address Book Public API