Create dictionary attribute value.

post

https://api-us.bluestonepim.com/pim/definitions/dictionary/{id}/values

Create a new dictionary attribute value for a dictionary attribute definition. This endpoint allows you to add a new value to the dictionary attribute definition.

Dictionaries are typically used for larger pre-defined lists of values (sometimes referred to as options in other systems). Each dictionary value is an object with properties like Name, Number and ID, where the ID is automatically generated by Bluestone PIM on creation.

For more detailed information on managing dictionary attributes, refer to our help pages Attribute types - Dictionary.

Path Params

string

required

Create a new dictionary attribute value by specifying the ID of the dictionary attribute definition and the details of the dictionary attribute value.

Body Params

metadata

string

length between 0 and 100

Specifies the new metadata for the dictionary attribute value.

number

string

length between 0 and 100

Specifies the new number of the dictionary attribute value. This value must be unique within the dictionary attribute definition. If not specified, the system will use the dictionary attribute value ID, which is a unique identifier generated by the system, as the default dictionary attribute value number.

value

string

required

length ≥ 1

Specifies the new value for the dictionary attribute value (sometimes referred to as a dictionary attribute option).

Headers

context

string

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

Responses

201Created Note: The new ID is included in the response headers under resource-id. See the example below: Example: resource-id: 664cc80da825236207fe01a7

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.

404Not Found This response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.

409Conflict This response indicates that the request could not be completed due to a conflict with the current state of the target resource. This typically occurs when there are duplicate entries or other data conflicts.