Update/create a reference entity

PATCH

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

This endpoint allows you to update a given reference entity. Note that if the reference entity does not already exist, it creates it.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/reference-entities/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "brands",
    "image": "0/2/d/6/54d81dc888ba1501a8g765f3ab5797569f3bv756c_ref_img.png",
    "labels": {
        "en_US": "Brands",
        "fr_FR": "Marques"
    }
}'

Response Example

201 - Example 1

{}

Request

Path Params

code

string

required

Code of the resource

Body Params application/json

code

string

required

Reference entity code

image

string

optional

Code of the reference entity image

Default:

null

labels

object

optional

Reference entity labels for each locale

Default:

{}

localeCode

string

optional

Reference entity label for the locale localeCode

Examples

Responses

🟢201Created

application/json

Body

object {0}

🟢204No content to return

🟠401Authentication required

🟠415Unsupported Media type

🟠422Unprocessable entity

Modified at 2023-08-15 05:53:55

Get a reference entity

Create a new media file for a reference entity or a record