Updates or assures a single communication mix based on the provided parameters.

Updated on Mar 20, 2026
Published on Jul 23, 2025

17 minute(s) reading time

Prev Next

Post

/api/v{version}/communicationmixes/{communicationMixId}

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

Min length0

Max length24

api-version

string

Path parameters

communicationMixId

stringRequired

version

stringRequired

Body parameters

Expand All

object

string | null

ID of the communication mix. If ID does not exist, a new communication mix will be created with this ID otherwise the existing communication mix will be modified.

code

string | null

Unique code of the communication mix.

name

string | null

Name of the communication mix.

contentTypes

Array of object (Contracts.Connect.Parameters.Broadcasts.ModifyCommunicationMixContentType) | null

List of content types that can be used in this communication mix.

object

string | null

ID of the content type.

code

string | null

Unique code of the content type.

name

string | null

Name of the content type.

durationSecs

number (double)

Duration of the content type in seconds.

filter

object (Contracts.Common.Entities.Filters.FilterConditionNodeJson)

permission

string

Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]

type

string

Valid values[ "None", "And", "Or", "Locations", "Aspects", "Tags", "Players", "Media", "Role", "Layers", "Clients", "Organizations", "Users", "PlayerStatus", "SearchTexts", "MatchingLocations", "AnyLocations", "MatchingRegions", "AnyRegions", "MatchingContentTypes", "AnyContentTypes", "MatchingAccounts", "NoLocations", "Accounts", "Customers", "Broadcasts", "ContentTypes", "MatchingCommunicationMixes", "AttributeValues", "LicenseContracts", "LicenseBusinessBrands", "LicenseCustomers", "LocationTags", "Channels" ]

all

boolean | null

none

boolean | null

matching

boolean | null

matchingButAllOnEmpty

boolean | null

mediaType

string

Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]

nodes

Array of object (Contracts.Common.Entities.Filters.FilterConditionNodeJson) | null

object Recursive

condition

string

Valid values[ "None", "In", "NotIn", "All", "Matching", "No", "MatchingButAllOnEmpty" ]

accounts

Array of object (Contracts.Common.Jsons.Refs.AccountRefJson) | null

object

Code

string | null

Min length0

Max length24

string | null

Min length0

Max length128

Name

string | null

Min length0

Max length50

clients

Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null

object

Code

string | null

Min length0

Max length24

string | null

Min length0

Max length128

Name

string | null

Min length0

Max length50

locations

Array of object (Contracts.Common.Jsons.Refs.LocationRefJson) | null

object

Code

string | null

Min length0

Max length24

string | null

Min length0

Max length128

Name

string | null

Min length0

Max length50

players

Array of object (Contracts.Common.Jsons.Refs.PlayerRefJson) | null

object

Code

string | null

Min length0

Max length24

string | null

Min length0

Max length128

Name

string | null

Min length0

Max length50

location

object (Contracts.Common.Jsons.Refs.LocationRefJson)

Code

string | null

Min length0

Max length24

string | null

Min length0

Max length128

Name

string | null

Min length0

Max length50

Documentation Index

Updates or assures a single communication mix based on the provided parameters.