Change an existing media group

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Put
/v{version}/MediaGroups/{id}

Read and write permissions are required for the specified parent media group. For admins, the Permissions property is required. For non-admin users, the Permissions property must be blank. The media group must be assigned to the same location as the parent group. The assigned location must be accessible to the user.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the media group

version
stringRequired

The requested API version

Default"1.18"
Body parameters

Change request that contains changed values of the media group

Expand All
object

Request for updating existing media group

AllowArchiving
boolean

If true, the media group allows archiving. Default: false.

AllowMediaArchiving
boolean

If true, the media group allows spot archiving. Default: false.

LocationId
integer (int32)

Unique ID of the location

Minimum1.0
Maximum2147483647.0
Name
string

Name of the media group

ParentId
integer (int32)

Unique ID of the parent media group

Minimum1.0
Maximum2147483647.0
Permissions
object

User group permissions of the media group

property*
object additionalProperties
Read
boolean
Write
boolean
Create
boolean
Delete
boolean
EditTemplate
boolean
VideoExport
boolean
Responses
200

OK

Expand All
object

Media group

AllowArchiving
boolean

If true, the media group allows archiving. Default: false.

AllowMediaArchiving
boolean

If true, the media group allows media archiving. Default: false.

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the media group

IsArchived
boolean

If true, the media group is archived. Default: false.

LocationId
integer (int32)

Unique ID of the location assigned to the media group

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the media group

ParentId
integer (int32)

Unique ID of the parent media group

Permissions
object

Permissions of the media group

Read
boolean
Write
boolean
Create
boolean
Delete
boolean
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties