Appearance
PUT
/campaign-property/property-keys/{propertyKeyId}Required scope:
viskan:campaignproperty:updateUpdates a campaign property key including its translations and predefined values.
Parameters
Path parameters
propertyKeyId integerThe unique identifier of the property key.
Request body
JSON
{
"name": "Color",
"keyGroup": "Appearance",
"usedForFilter": true,
"usedForPresentation": true,
"allowUpdateInUI": true,
"sendToShippingProvider": true,
"sort": 0,
"translations": {
"added": [
{
"languageCode": "sv",
"name": "Färg",
"description": "..."
}
],
"modified": [
{
"languageCode": "sv",
"name": "Färg",
"description": "..."
}
],
"removed": [
"sv",
"en"
]
},
"values": {
"added": [
{
"value": "Red",
"mediaURL": "...",
"filterTag": "...",
"sort": 0,
"translations": [
{...}
]
}
],
"modified": [
{
"propertyValueId": 1,
"value": "Red",
"mediaURL": "...",
"filterTag": "...",
"sort": 0,
"translations": [
{...}
]
}
],
"removed": [
12345
]
}
}
Response
The property key was updated successfully.
JSON
{
"propertyKeyId": 1,
"name": "Color",
"presentation": "SINGLE_SELECT",
"keyGroup": "Appearance",
"usedForFilter": true,
"usedForPresentation": true,
"allowUpdateInUI": true,
"sendToShippingProvider": true,
"sort": 0,
"translations": [
{
"languageCode": "sv",
"name": "Färg",
"description": "..."
}
],
"values": [
{
"propertyValueId": 1,
"value": "Red",
"mediaURL": "...",
"filterTag": "...",
"sort": 0,
"translations": [
{
"languageCode": "sv",
"name": "Röd",
"description": "..."
}
]
}
]
}
| Error code | Description |
|---|---|
duplicate-property-value | Two or more values have the same name. |
invalid-property-key-name | The property key name must not be empty. |
language-not-found | An unknown language code was provided. |
property-key-name-already-exists | A property key with this name already exists. |
property-key-not-found | The property key was not found. |