Skip to content

Update a product property

PUT
/api/tenant/{tenantId}/ProductProperties/{id}
curl --request PUT \
--url https://api.nimles.com/pim/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ProductProperties/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "uniqueName": "example", "parentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "options": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "Inherit", "name": "example", "nameLocalized": { "additionalProperty": "example" }, "uniqueName": "example", "value": "example", "description": "example" } ], "unit": "example", "description": "example", "descriptionLocalized": { "additionalProperty": "example" }, "type": "Undefined", "name": "example", "nameLocalized": { "additionalProperty": "example" }, "title": "example", "titleLocalized": { "additionalProperty": "example" }, "placeholder": "example", "placeholderLocalized": { "additionalProperty": "example" }, "isMulti": true, "useAsFilter": true, "required": true, "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
id
required
string format: uuid
tenantId
required
string format: uuid

Your tenant id.

Media typeapplication/json
object
fields
object
key
additional properties
object
value
nullable
valueType
string
nullable
uniqueName
string
nullable
parentId
string format: uuid
nullable
options
Array<object>
nullable
object
id
string format: uuid
fields
object
key
additional properties
object
value
nullable
valueType
string
nullable
accessibility
string
Allowed values: Inherit System Application Private Shared SharedExplicit Public PublicExplicit
name
string
nullable
nameLocalized
object
key
additional properties
string
uniqueName
string
nullable
value
string
nullable
description
string
nullable
unit
string
nullable
description
string
nullable
descriptionLocalized
object
key
additional properties
string
type
string
Allowed values: Undefined Number Option MultiOption SingleOption String MultiLineText SingleLineText Color File Url Parent
name
string
nullable
nameLocalized
object
key
additional properties
string
title
string
nullable
titleLocalized
object
key
additional properties
string
placeholder
string
nullable
placeholderLocalized
object
key
additional properties
string
isMulti
boolean
useAsFilter
boolean
required
boolean
organizationId
string format: uuid
nullable

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
organizationId
string format: uuid
nullable
options
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
nameLocalized
object
key
additional properties
string
uniqueName
string
nullable
value
string
nullable
description
string
nullable
uniqueName
string
nullable
parentId
string format: uuid
nullable
name
string
nullable
nameLocalized
object
key
additional properties
string
title
string
nullable
titleLocalized
object
key
additional properties
string
placeholder
string
nullable
placeholderLocalized
object
key
additional properties
string
unit
string
nullable
description
string
nullable
descriptionLocalized
object
key
additional properties
string
type
required
string
nullable
isMulti
boolean
useAsFilter
boolean
required
boolean

Example generated

{
"data": {
"fields": {
"additionalProperty": {
"value": "example",
"valueType": "example"
}
},
"accessibility": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"relations": [
{
"fields": {
"additionalProperty": {
"value": "example",
"valueType": "example"
}
},
"accessibility": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"entityType": "example",
"relationType": "example"
}
],
"tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"createdDate": "2026-04-15T12:00:00Z",
"version": 1,
"lastModified": "2026-04-15T12:00:00Z",
"organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"options": [
{
"fields": {
"additionalProperty": {
"value": "example",
"valueType": "example"
}
},
"accessibility": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"nameLocalized": {
"additionalProperty": "example"
},
"uniqueName": "example",
"value": "example",
"description": "example"
}
],
"uniqueName": "example",
"parentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"nameLocalized": {
"additionalProperty": "example"
},
"title": "example",
"titleLocalized": {
"additionalProperty": "example"
},
"placeholder": "example",
"placeholderLocalized": {
"additionalProperty": "example"
},
"unit": "example",
"description": "example",
"descriptionLocalized": {
"additionalProperty": "example"
},
"type": "example",
"isMulti": true,
"useAsFilter": true,
"required": true
}
}

No Content: done, with no item to return.

Unauthorized: no bearer token, or one that is expired or not for this API.

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"errors": {
"additionalProperty": [
"example"
]
},
"status": 1,
"title": "example",
"type": "example"
}