Item

Update an item

Updates an existing item with new data including definition and synonyms

put/api/item/{id}

Request

Path parameters

idinteger required

ID of the item to update

Request body

namestring required

Name of the asset

item_platform_idinteger required

Platform ID

item_subplatform_idinteger required

Subplatform ID

item_grouping_idinteger required

Grouping ID

default_rankinteger

Default rank for the asset

descriptionstring

Description of the asset

hasAmountboolean

Whether the asset has amount

hasDescriptionboolean

Whether the asset has description

hasFrequencyboolean

Whether the asset has frequency

hasImagesboolean

Whether the asset has images

hasVideosboolean

Whether the asset has videos

isDigitalboolean

Whether the asset is digital

isPrintboolean

Whether the asset is print

isRadioboolean

Whether the asset is radio

isSocialboolean

Whether the asset is social

isSponsorboolean

Whether the asset is sponsor

isTvboolean

Whether the asset is TV

isVendorboolean

Whether the asset is vendor

isOutOfHomeboolean

Whether the asset is out of home

definitionstring

Definition of the asset

synonymsstring[]

All of the asset's synonyms. On an update, a name already saved keeps its row, a saved name that is not sent is deleted and a new name is added; leave the field out to keep the synonyms as they are.

Response

Item updated successfully

idinteger

Asset ID

namestring

Asset name

descriptionstring nullable

Asset description

default_rankinteger

Default rank for the asset

item_platform_idinteger

Platform ID

item_subplatform_idinteger

Subplatform ID

item_grouping_idinteger

Grouping ID

hasFrequencyboolean

Whether the asset has frequency

hasDescriptionboolean

Whether the asset has description

hasImagesboolean

Whether the asset has images

hasVideosboolean

Whether the asset has videos

hasSocialMediaValueboolean

Whether the asset has social media value

hasAmountboolean

Whether the asset has amount

is_premiumboolean

Whether the asset is premium

isSponsorboolean

Whether the asset is sponsor

isTvboolean

Whether the asset is TV

isRadioboolean

Whether the asset is radio

isVendorboolean

Whether the asset is vendor

isSocialboolean

Whether the asset is social

isDigitalboolean

Whether the asset is digital

isPrintboolean

Whether the asset is print

isOutOfHomeboolean

Whether the asset is out of home

definitionstring nullable

Asset definition name

synonymsstring[]

Array of synonym strings

Changes

No recorded changes to this operation across all 2 revisions of this API.