Mike.robski: 1 revision: Release 99

2014-10-14T15:07:20Z

1 revision: Release 99

Pa.dinh at 17:04, 18 September 2014

2014-09-18T17:04:13Z

Show changes

Mike.robski: 1 revision: Release 93

2014-05-08T07:34:10Z

1 revision: Release 93

Petre.popescu at 20:12, 9 April 2014

2014-04-09T20:12:34Z

New page

= PUT /accounts/''{accountId}''/contacts =
Set the contact details for an account
__TOC__

== Request ==
<code>PUT /accounts/''{accountId}''/contacts</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

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

=== Request Body ===
<nowiki>
{
"regular": {
"city": "{city}",
"company": "{company}",
"countryCode": "{countryCode}",
"email1": "{email1}",
"email2": "{email2}",
"fax": "{fax}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"middleName": "{middleName}",
"phone1": "{phone1}",
"phone2": "{phone2}",
"postalCode": "{postalCode}",
"salutation": "{salutation}",
"stateOrProvince": "{stateOrProvince}",
"street1": "{street1}",
"street2": "{street2}"
},
"billing": {
"city": "{city}",
"company": "{company}",
"countryCode": "{countryCode}",
"email1": "{email1}",
"email2": "{email2}",
"fax": "{fax}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"middleName": "{middleName}",
"phone1": "{phone1}",
"phone2": "{phone2}",
"postalCode": "{postalCode}",
"salutation": "{salutation}",
"stateOrProvince": "{stateOrProvince}",
"street1": "{street1}",
"street2": "{street2}"
},
"administrator": {
"city": "{city}",
"company": "{company}",
"countryCode": "{countryCode}",
"email1": "{email1}",
"email2": "{email2}",
"fax": "{fax}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"middleName": "{middleName}",
"phone1": "{phone1}",
"phone2": "{phone2}",
"postalCode": "{postalCode}",
"salutation": "{salutation}",
"stateOrProvince": "{stateOrProvince}",
"street1": "{street1}",
"street2": "{street2}"
},
"technical": {
"city": "{city}",
"company": "{company}",
"countryCode": "{countryCode}",
"email1": "{email1}",
"email2": "{email2}",
"fax": "{fax}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"middleName": "{middleName}",
"phone1": "{phone1}",
"phone2": "{phone2}",
"postalCode": "{postalCode}",
"salutation": "{salutation}",
"stateOrProvince": "{stateOrProvince}",
"street1": "{street1}",
"street2": "{street2}"
}
}
</nowiki>

==== Parameters ====
Note, there are 4 types of contact information that must be sent with the request: "regular", "billing", "administrator" and "technical". All 4 are required.

; city - ''string''
: ''(REQUIRED)''
: May be up to 50 characters long. May contain only alphanumerics, white space and the following characters: -.'

; company - ''string''
: ''(OPTIONAL)''
: May be up to 200 characters long. May contain only alphanumerics, white space and the following characters: -.'

; countryCode - ''string''
: ''(REQUIRED)''
: ISO 3166-1 alpha-2[http://www.iso.org/iso/iso-3166-1_decoding_table.html] country code.

; email1 - ''string''
: ''(REQUIRED)''
: May be up to 100 characters long. Must contain a valid e-mail address.

; email2 - ''string''
: ''(OPTIONAL)''
: May be up to 100 characters long. If provided, must contain a valid e-mail address.

; fax - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. If provided, must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; firstName - ''string''
: ''(REQUIRED)''
: May be up to 50 characters long. May contain only alphanumerics, white space and the following characters: -.'

; lastName - ''string''
: ''(REQUIRED)''
: May be up to 50 characters long. May contain only alphanumerics, white space and the following characters: -.'

; middleName - ''string''
: ''(OPTIONAL)''
: May be up to 50 characters long. If provided, may contain only alphanumerics, white space and the following characters: -.'

; phone1 - ''string''
: ''(REQUIRED)''
: May be up to 20 characters long. Must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; phone2 - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. If provided, must contain ITU-T E.164[http://www.itu.int/rec/T-REC-E.164/en] formatted phone number.

; postalCode - ''string''
: ''(OPTIONAL)''
: May be up to 30 characters long. May contain only alphanumerics, white space and the following characters: -.' This value is *required* if the value of ''countryCode'' is "US" or "CA". If the value of ''countryCode'' is "US", then ''postalCode'' must be in format "#####" or "#####-####" (where "#" represents any numeric digit). If the value of ''countryCode'' is "CA", then ''postalCode'' must be in format "A#A#A#" or "A#A-#A#" or "A#A #A#" (where "A" represents any latin alphabet character and "#" represents any numeric digit).

; salutation - ''string''
: ''(OPTIONAL)''
: May contain one of the salutations provided by [[Salutations:GET|GET /salutations]]

; stateOrProvince - ''string''
: ''(OPTIONAL)''
: May be up to 20 characters long. May contain only alphanumerics, white space and the following characters: -.' This value is *required* if the value of ''countryCode'' is "US" or "CA". If the value of ''countryCode'' is "US", then ''stateOrProvince'' must be a valid two-letter US state abbreviation. If the value of ''countryCode'' is "CA", then ''stateOrProvince'' must be a valid two-letter Canadian province abbreviation.

; street1 - ''string''
: ''(REQUIRED)''
: May be up to 100 characters long. May contain only alphanumerics, white space and the following characters: -.'

; street2 - ''string''
: ''(OPTIONAL)''
: May be up to 100 characters long. If provided, may contain only alphanumerics, white space and the following characters: -.'

== Response ==

=== Status Code ===
; 204 No Content
: Successfully updated contact information

; 400 Bad Request
: Contact information was not updated because either the request body was malformed, or some element of the request body did not meet the requirements.

; 401 Unauthorized
: The request was sent without an ''Authorization'' header, or the user represented by the value of this header was not properly authenticated.

; 403 Forbidden
: The user authenticated for this request is not allowed to access the resource.

; 404 Not Found
: The account Id was not found.

=== Response Body ===
None.

== Examples ==
=== Successful update of contact information ===
''Request''
<nowiki>
PUT /accounts/{accountId}/contacts

Authorization: Basic {Base64-encoded username & password string}

{
"regular": {
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
},
"billing": {
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
},
"administrator": {
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
},
"technical": {
"city": "Chicago",
"company": "TestCo, Inc.",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"salutation": "Mr.",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
}
</nowiki>

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

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-accountId-Contacts:PUT - Revision history

Mike.robski: 1 revision: Release 99

Pa.dinh at 17:04, 18 September 2014

Mike.robski: 1 revision: Release 93

Petre.popescu at 20:12, 9 April 2014