Patch Reference Entity By Code

Update/create a reference entity

PATCH/api/rest/v1/reference-entities/{code}

Use it in a workflow

Add a step and choose the Akeneo connector.
Pick the Patch Reference Entity By Code action (under Reference entity).
Fill in the fields below, then reference the result from later steps as {{patchReferenceEntityByCode.response.data}}.

Request

Path parameters

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.

codestringrequired

Reference entity code

labelsobject

Reference entity labels for each locale

Default {}

imagestring | null

Code of the reference entity image

Default null

json

{
  "code": "brands",
  "labels": {
    "en_US": "Brands",
    "fr_FR": "Marques"
  },
  "image": "0/2/d/6/54d81dc888ba1501a8g765f3ab5797569f3bv756c_ref_img.png"
}

Response

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

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

Was this page helpful?