younifyd
Menu

Patch Attribute Option By Code

Update/create an attribute option

PATCH/api/rest/v1/attributes/{attribute_code}/options/{code}

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Patch Attribute Option By Code action (under Attribute option).
  3. Fill in the fields below, then reference the result from later steps as {{patchAttributeOptionByCode.response.data}}.

Request

Path parameters

attribute_codestringrequired

This path parameter is used to specify the unique identifier of the attribute you want to retrieve or manipulate. It is essential for identifying the specific attribute in the API requests. Ensure that the attribute code is correctly formatted and corresponds to an existing attribute in the system.

codestringrequired

This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the code is correctly formatted and corresponds to an existing entity in the system.

Request body

Enter the body as JSON in the step's Body field.

codestring

Code of option

attributestring

Code of attribute related to the attribute option

sort_orderinteger

Order of attribute option

labelsobject

Attribute option labels for each locale

Default {}

json
{
  "code": "black",
  "attribute": "a_simple_select",
  "sort_order": 2,
  "labels": {
    "en_US": "Black",
    "fr_FR": "Noir",
    "de_DE": "Schwarz"
  }
}

Response

Returns 201 with a any. Read it in later steps with {{patchAttributeOptionByCode.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.

Patch Attribute Option By Code — Akeneo — Documentation