Update/create an attribute of a given asset family

This endpoint allows you to update a given attribute for a given asset family. Note that if the attribute does not already exist for the given asset family, it creates it.

curl --location --request PATCH '/api/rest/v1/asset-families//attributes/' \ --header 'Content-Type: application/json' \ --data-raw '{ "code": "model_is_wearing_size", "is_required_for_completeness": true, "labels": { "en_US": "Model is wearing size", "fr_FR": "Le mannequin porte la taille" }, "type": "single_option", "value_per_channel": false, "value_per_locale": false }'

Request

Path Params

asset_family_code

string

required

Code of the asset family

code

string

required

Code of the resource

Body Params application/json

allowed_extensions

array[string]

optional

Extensions allowed when the attribute type is media_file

code

string

required

Attribute code

decimals_allowed

boolean

optional

Whether decimals are allowed when the attribute type is number

Default:

false

is_read_only

boolean

optional

Whether the attribute should be in read only mode only in the UI, but you can still update it with the API

Default:

false

is_required_for_completeness

boolean

optional

Whether the attribute should be part of the record's completeness calculation

Default:

false

is_rich_text_editor

boolean

optional

Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text

is_textarea

boolean

optional

Whether the UI should display a text area instead of a simple field when the attribute type is text

Default:

false

labels

object

optional

Attribute labels for each locale

Default:

{}

localeCode

string

optional

Attribute label for the locale localeCode

max_characters

integer

optional

Maximum number of characters allowed for the value of the attribute when the attribute type is text

max_file_size

string

optional

Max file size in MB when the attribute type is media_file

Default:

null

max_value

string

optional

Maximum value allowed when the attribute type is number

Default:

null

media_type

enum<string>

required

For the media_link attribute type, it is the type of the media behind the url, to allow its preview in the PIM. For the media_file attribute type, it is the type of the file.

Allowed values:

imagepdfyoutubevimeoother

min_value

string

optional

Minimum value allowed when the attribute type is number

Default:

null

prefix

string

optional

Prefix of the media_link attribute type. The common url root that prefixes the link to the media

Default:

null

suffix

string

optional

Suffix of the media_link attribute type. The common url suffix for the media

Default:

null

type

enum<string>

required

Attribute type. See type section for more details.

Allowed values:

textmedia_linknumbermedia_filesingle_optionmultiple_optionsreference_entity_single_linkreference_entity_multiple_linksboolean

validation_regexp

string

optional

Regexp expression used to validate the attribute value when the attribute type is text

Default:

null

validation_rule

enum<string>

optional

Validation rule type used to validate the attribute value when the attribute type is text

Allowed values:

emailurlregexpnone

Default:

none

value_per_channel

boolean

optional

Whether the attribute is scopable, i.e. can have one value by channel

Default:

false

value_per_locale

boolean

optional

Whether the attribute is localizable, i.e. can have one value by locale

Default:

false

Examples

Update/create an attribute of a given asset family

Request

Responses