Latest revision as of 13:12, 24 July 2015

[edit] PUT /accounts/{accountId}/attributes/{attribute}

Updates attribute value.

[edit] Request

PUT /accounts/{accountId}/attributes/{attribute}

[edit] Parameters

accountId - string

The Id of the Hostway account.

[edit] URI Parameters

attribute - string

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

application/json

[edit] Request Body

{
    "value": "{value}"
}
 

[edit] Parameters

value - string

[edit] Response

[edit] Status Code

204 No Content

Success.

400 Bad Request

The format of the request body is invalid.

401 Unauthorized

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

403 Forbidden

Forbidden access to a user not authorized for such access.

404 Not Found

The account Id or attribute were not found.

415 Unsupported Media Type

The Content-Type header was not specified or the specified type is not supported. Use application/json.

[edit] Examples

[edit] Sending unauthorized request

Request

PUT /accounts/account-id/attributes/test_attribute

{"value": "test"}
 

Response

401 Unauthorized
 

[edit] Sending request without setting Content-Type

Request

PUT /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)

{"value": "test"}
 

Response

415 Unsupported Media Type
 

[edit] Failure updating not existing attribute

Request

PUT /accounts/account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{"value": "test"}
 

Response

404 Not Found
 

[edit] Failure updating attribute with missing required value

Request

PUT /accounts/account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{}
 

Response

400 Bad Request

{"value":"Required"}
 

[edit] Success scenario

Request

PUT /accounts/account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{"value": "test"}
 

Response

204 No Content
 

[edit] See also

• Account Management API
• Common Features