Partially update an attribute value

Updates one or more fields of an existing attribute value. Only the fields you send are changed. The attribute + value uniqueness rule is re-checked, and the LANDING_PAGE_ATTRIBUTES landing-page behavior described for the full update applies.

patch

/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 partially updating an attribute value. All fields are optional; only the fields you send are changed.

attributeintegerOptional

The identifier of the parent attribute.

valuestringOptional

The value.

orderinteger · nullableOptional

The sort order of the 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

patch/attribute_value/{id}/

PATCH /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"
}