Update an attribute value

Replaces the details of an existing attribute value. Provide the full set of writable fields. The attribute + value uniqueness rule is re-checked.

Dynamic Setting

Setting Key	Type	Default	Effect
LANDING_PAGE_ATTRIBUTES	array of strings	[]	When the parent attribute's key is in this list, the attribute value's landing page is created or kept in sync. See the Dynamic Settings & Environment Variables section.

put

/attribute_value/{id}/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters

idintegerRequired

The unique identifier of the attribute value.

Body

The payload accepted when creating or fully updating an attribute value.

attributeintegerRequired

The identifier of the parent attribute. Together with value, must be unique.

valuestringRequired

The value. Together with attribute, must be unique.

orderinteger · nullableOptional

The sort order of the value. When omitted, the server tries to derive it from the numeric interpretation of value.

labelstring · nullableOptional

The translatable display label of the value.

translationsobject · nullableWrite-onlyOptional

Localized values of the translatable fields, keyed by language code. Write-only.

Responses

200

The updated attribute value.

application/json

A predefined value of an attribute as returned by the API.

pkintegerRead-onlyOptional

The unique identifier of the attribute value.

attributeintegerOptional

The identifier of the parent attribute.

valuestringOptional

The value.

orderinteger · nullableOptional

The sort order of the value. Values are listed by order, then value.

labelstring · nullableOptional

The translatable display label of the value, when any.

400

The request contains invalid or missing data.

application/json

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

404

The requested attribute value does not exist.

application/json

put/attribute_value/{id}/

PUT /api/remote/1/attribute_value/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "attribute": 1,
  "value": "text",
  "order": null,
  "label": null,
  "translations": null
}

{
  "pk": 501,
  "attribute": 42,
  "value": "Red",
  "order": 1,
  "label": "Red"
}