Documentation Index

Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt

Use this file to discover all available pages before exploring further.

/api/clients/{clientId}

  • Updated on Mar 20, 2026
  • Published on Jul 23, 2025
  • 26 minute(s) reading time
Prev Next
Put
/api/clients/{clientId}
Security
OAuth

Authorization using OAuth2 with Client Credentials

FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string
Min length0
Max length128
x-onBehalfOf
string
api-version
string
Path parameters
clientId
stringRequired
Min length0
Max length128
Body parameters
Expand All
object
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
name
string | null
Min length0
Max length50
alias
string | null
Min length0
Max length128
settings
object (Contracts.Connect.Parameters.Clients.UpdateClientParameterSettings)
values
Array of object (Contracts.Connect.Parameters.Clients.UpdateClientParameterSettingAttribute) | null
object
attribute
object (Contracts.Common.Jsons.Refs.AttributeRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Item", "POSItem", "ClientLocationPlayer", "Offer", "Assortment", "Record", "AssortmentItem", "TreeSchemaLevel" ]
valueType
string
Valid values[ "String", "Currency", "Day", "DateTime", "Int", "Float", "Media", "DatePeriod", "Record", "Bool", "Slider" ]
attributeFlags
string
Valid values[ "None", "Mandatory", "Default", "Share", "ValidityPeriod", "Options", "Fixed", "Multi", "ShowAsListColumn" ]
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
name
string | null
Min length0
Max length50
value
string | null
Min length0
Max length768
dValue
number (double) | null
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[ "None", "BookingMedia", "Logos", "OfferMedia", "ItemImages", "HtmlTemplates", "HousingAds", "BookingCommentFiles", "Maps", "PlayerScreenShots", "ADinQ", "Facebook", "PlayoutEntities", "Instagram", "WebPages", "Unsplash", "Documents", "FallbackMedia", "OfferSigns", "HtmlTemplateSystemFiles", "ImportDocuments" ]
removeOverrides
boolean | null
isRemove
boolean
tags
object (Contracts.Connect.Parameters.ModifyParameterTags)
mode
string
Valid values[ "Append", "Replace", "Remove" ]
tags
object | null
None
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Profile
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Zone
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Whatever
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
MediaFormat
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Permission
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Application
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Cluster
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
ContentType
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Item
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
POSItem
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Assortment
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Record
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Location
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Region
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Offer
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Customer
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
PlayerFeature
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
AI
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Media
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Player
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
LocationRef
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
clearTagsTypes
Array of string (Contracts.Common.Enums.Tags.TagTypeEnum) | null
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
rateLimit
integer (int32) | null
Expand All
object
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
name
string | null
Min length0
Max length50
alias
string | null
Min length0
Max length128
settings
object (Contracts.Connect.Parameters.Clients.UpdateClientParameterSettings)
values
Array of object (Contracts.Connect.Parameters.Clients.UpdateClientParameterSettingAttribute) | null
object
attribute
object (Contracts.Common.Jsons.Refs.AttributeRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Item", "POSItem", "ClientLocationPlayer", "Offer", "Assortment", "Record", "AssortmentItem", "TreeSchemaLevel" ]
valueType
string
Valid values[ "String", "Currency", "Day", "DateTime", "Int", "Float", "Media", "DatePeriod", "Record", "Bool", "Slider" ]
attributeFlags
string
Valid values[ "None", "Mandatory", "Default", "Share", "ValidityPeriod", "Options", "Fixed", "Multi", "ShowAsListColumn" ]
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
name
string | null
Min length0
Max length50
value
string | null
Min length0
Max length768
dValue
number (double) | null
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[ "None", "BookingMedia", "Logos", "OfferMedia", "ItemImages", "HtmlTemplates", "HousingAds", "BookingCommentFiles", "Maps", "PlayerScreenShots", "ADinQ", "Facebook", "PlayoutEntities", "Instagram", "WebPages", "Unsplash", "Documents", "FallbackMedia", "OfferSigns", "HtmlTemplateSystemFiles", "ImportDocuments" ]
removeOverrides
boolean | null
isRemove
boolean
tags
object (Contracts.Connect.Parameters.ModifyParameterTags)
mode
string
Valid values[ "Append", "Replace", "Remove" ]
tags
object | null
None
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Profile
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Zone
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Whatever
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
MediaFormat
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Permission
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Application
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Cluster
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
ContentType
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Item
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
POSItem
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Assortment
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Record
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Location
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Region
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Offer
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Customer
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
PlayerFeature
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
AI
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Media
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Player
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
LocationRef
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
clearTagsTypes
Array of string (Contracts.Common.Enums.Tags.TagTypeEnum) | null
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
rateLimit
integer (int32) | null
Expand All
object
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
name
string | null
Min length0
Max length50
alias
string | null
Min length0
Max length128
settings
object (Contracts.Connect.Parameters.Clients.UpdateClientParameterSettings)
values
Array of object (Contracts.Connect.Parameters.Clients.UpdateClientParameterSettingAttribute) | null
object
attribute
object (Contracts.Common.Jsons.Refs.AttributeRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Item", "POSItem", "ClientLocationPlayer", "Offer", "Assortment", "Record", "AssortmentItem", "TreeSchemaLevel" ]
valueType
string
Valid values[ "String", "Currency", "Day", "DateTime", "Int", "Float", "Media", "DatePeriod", "Record", "Bool", "Slider" ]
attributeFlags
string
Valid values[ "None", "Mandatory", "Default", "Share", "ValidityPeriod", "Options", "Fixed", "Multi", "ShowAsListColumn" ]
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
name
string | null
Min length0
Max length50
value
string | null
Min length0
Max length768
dValue
number (double) | null
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[ "None", "BookingMedia", "Logos", "OfferMedia", "ItemImages", "HtmlTemplates", "HousingAds", "BookingCommentFiles", "Maps", "PlayerScreenShots", "ADinQ", "Facebook", "PlayoutEntities", "Instagram", "WebPages", "Unsplash", "Documents", "FallbackMedia", "OfferSigns", "HtmlTemplateSystemFiles", "ImportDocuments" ]
removeOverrides
boolean | null
isRemove
boolean
tags
object (Contracts.Connect.Parameters.ModifyParameterTags)
mode
string
Valid values[ "Append", "Replace", "Remove" ]
tags
object | null
None
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Profile
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Zone
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Whatever
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
MediaFormat
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Permission
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Application
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Cluster
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
ContentType
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Item
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
POSItem
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Assortment
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Record
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Location
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Region
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Offer
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Customer
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
PlayerFeature
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
AI
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Media
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
Player
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
LocationRef
Array of object (Contracts.Connect.Parameters.UpdateParameterTag)
object
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
code
string | null
Min length0
Max length128
id
string | null
name
string | null
clearTagsTypes
Array of string (Contracts.Common.Enums.Tags.TagTypeEnum) | null
string
Valid values[ "None", "Profile", "Zone", "Whatever", "MediaFormat", "Permission", "Application", "Cluster", "ContentType", "Item", "POSItem", "Assortment", "Record", "Location", "Region", "Offer", "Customer", "PlayerFeature", "AI", "Media", "Player", "LocationRef" ]
rateLimit
integer (int32) | null
Responses
200

OK

Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
clients
Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
externalId
string | null
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
clients
Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
externalId
string | null
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
clients
Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
externalId
string | null
400

Bad Request

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401

Unauthorized

403

Forbidden

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
404

Not Found

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500

Internal Server Error

Products
Company
Support
Follow us
© 2025 Grassfish. All Rights Reserved.