Update column attribute definition.

put

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

Update an existing column attribute definition using its internal ID. This endpoint allows modifying the definition's properties and validation strategies.

For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages Get started with Management API and Attribute types - Column.

Path Params

string

required

The internal ID for the column attribute definition you want to update.

Example: 634c26e14cedfd0001775e9f

Query Params

validation

string

enum

required

Validation strategy for the creation operation. Can be either NAME or NONE and defaults to NAME.

NAME means that a validation check will be performed to make sure that no other attribute definition exist with the same name.

NONE can be used to create an attribute definition with the same name as an other existing attribute definition. Note: The number must always be unique.

Allowed:

Body Params

contextAware

boolean

description

string

externalSource

boolean

Specifies whether the origin of the attribute is managed in an external source like an ERP system or managed by a cloud function like an AWS Lambda or Azure Function and hence the attribute should be read-only for the editors in the Bluestone PIM web application UI.

Note: The value of the attribute can still be modified via the Management API, for example by an integration or a cloud function triggered by a webhook message from Bluestone PIM.

groupId

string

ID of the attribute group that the attribute definition belongs to.

Example: 634c26e14cedfd0001775e9f

internal

boolean

Indicates that the attribute is for internal use only within Bluestone PIM, meaning this value is not visible in the Public API (PAPI) for systems downstream of Bluestone PIM; for example, attributes for system configuration, enrichment workflows, or internal categorization.

name

string

Name of the attribute definition.

number

string

Number of the attribute definition.

restrictions

object

Restrictions related to the attribute definition.

Responses

200OK This response indicates that the request was successfully processed and the column attribute definition has been updated.

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.