Orders-orderId-account-attributes:PUT

2013-09-27T13:48:01Z

Alexander.pyatkov: /* Parameters */

= PUT /orders/''{orderId}''/account/attributes =
Set the list of attributes for an account in a given order.
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/attributes</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
[
{
"name": "{attributeName}",
"value": "{attributeValue}"
},
{
"name": "{attributeName}",
"value": "{attributeValue}"
}
]
</nowiki>

==== Parameters ====
; attributeName - ''string''
: The unique name of the attribute. The list of supported attribute names is specific to the franchise. The common attributes include:
:: '''partner_account_id''' - unique account identifier in the partner system. The value should be unique within the franchise.

; attributeValue - ''string''
: The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.
: The value of the "partner_account_id" attribute is max 100 characters

== Response ==

=== Status Code ===
;204 No Content : The account attributes were successfully set.

;400 Bad Request : The request body format is invalid, the attribute name is not supported by the franchise, the attribute value is invalid (e.g: too long, contains invalid characters, etc).

;404 Not Found : The specified order does not exist.

;409 Conflict : An attribute value, supposed to be unique, is already in use.

;502 Bad Gateway : A critical (unknown) error occurred.

=== Response Body ===
None.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Hostway API Documentation - User contributions [en]

Orders-orderId-account-attributes:PUT