Add a new update group

Published on Aug 7, 2026

Prev Next

Post

/v{version}/UpdateGroups

Security

API Key: api_key

Header parameter nameX-ApiKey

Api Key

API Key: session_id

Header parameter nameX-Session-Id

Session Id

Path parameters

version

stringRequired

The requested API version

Body parameters

The request containing the update group details.

Expand All

object

Request model for adding a new update group with relevant properties

AddonUpdates

Array of object (V1.Models.AddUpdateGroupRequestAddonUpdate)

List of addon update identifiers for the update group creation

object

Addon update information for adding an update group

ForceVersion

boolean

Indicates whether to force the version for the addon update

integer (int32) Required

Unique identifier of the addon update

Minimum1

Maximum2147483647

Architecture

string Required

Target architecture for the new update group

EditionId

integer (int32) Required

Identifier of the edition for the new update group

Minimum1

Maximum2147483647

Name

string Required

Display name for the new update group

Platform

string Required

Target platform for the new update group

PlayerUpdate

object (V1.Models.AddUpdateGroupRequestPlayerUpdate) Required

Player update information for adding an update group

integer (int32) Required

Unique identifier of the player update

Minimum1

Maximum2147483647

PlayerUpdateType

string Required

Type of player update for the new update group

ScriptUpdates

Array of object (V1.Models.AddUpdateGroupRequestScriptUpdate)

List of script update identifiers for the update group creation

object

Script update information for adding an update group

integer (int32) Required

Unique identifier of the script update

Minimum1

Maximum2147483647

Responses

200

Expand All

object

Detailed model of an update group including update and addon information

AddonUpdates

Array of object (V1.Models.UpdateGroupDetailsAddonUpdate)

List of addon update information for the update group detail

object

Update information for the addon update group with update metadata fields

Architecture

string

Target architecture of the update

ForceVersion

boolean

Indicates whether to force the version for the addon update

integer (int32)

Unique identifier of the update

MaxPlayerVersion

string

Maximum player version supported by the update

MinPlayerVersion

string

Minimum player version required for the update

Name

string

Display name of the update

PackageGuid

string (uuid)

Optional package GUID associated with the update

PackageType

string

Specifies the type of update package.

Valid values[ "PlayerUpdate", "Addon", "Script" ]

Platform

string

Supported platforms

Valid values[ "Windows", "Linux", "Android", "Tizen" ]

SemanticVersion

string

Semantic version of the update

Architecture

string

Target architecture of the update group detail

Created

string (date-time)

Creation date in UTC

Edition

object (V1.Models.UpdateGroupDetailsEdition)

Edition details within the update group detailed view

Code

string (uuid)

Unique code for the edition detail

integer (int32)

Unique identifier of the edition detail

Name

string

Display name of the edition detail

integer (int32)

Unique identifier of the update group detail

Modified

string (date-time)

Modification date in UTC

Name

string

Display name of the update group detail

Platform

string

Supported platforms

Valid values[ "Windows", "Linux", "Android", "Tizen" ]

PlayerUpdate

object (V1.Models.UpdateGroupDetailsPlayerUpdate)

Update information for the player update group with update metadata fields

Architecture

string

Target architecture of the update

integer (int32)

Unique identifier of the update

MaxPlayerVersion

string

Maximum player version supported by the update

MinPlayerVersion

string

Minimum player version required for the update

Name

string

Display name of the update

PackageGuid

string (uuid)

Optional package GUID associated with the update

PackageType

string

Specifies the type of update package.

Valid values[ "PlayerUpdate", "Addon", "Script" ]

Platform

string

Supported platforms

Valid values[ "Windows", "Linux", "Android", "Tizen" ]

PlayerUpdateType

string

Player update types

Valid values[ "Default", "Migration" ]

SemanticVersion

string

Semantic version of the update

PlayerUpdateType

string

Player update types

Valid values[ "Default", "Migration" ]

ScriptUpdates

Array of object (V1.Models.UpdateGroupDetailsScriptUpdate)

List of script update information for the update group detail

object

Update information for the script update group with update metadata fields

Architecture

string

Target architecture of the update

integer (int32)

Unique identifier of the update

MaxPlayerVersion

string

Maximum player version supported by the update

MinPlayerVersion

string

Minimum player version required for the update

Name

string

Display name of the update

PackageGuid

string (uuid)

Optional package GUID associated with the update

PackageType

string

Specifies the type of update package.

Valid values[ "PlayerUpdate", "Addon", "Script" ]

Platform

string

Supported platforms

Valid values[ "Windows", "Linux", "Android", "Tizen" ]

SemanticVersion

string

Semantic version of the update

400

Bad Request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

401

Unauthorized

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

403

Forbidden

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

404

Not Found

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

500

Unexpected error

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties