Change an existing spot group

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

Only admin or standard user can change template group.

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 spot group

version
stringRequired

The requested API version

Default"1.18"
Body parameters

Change request that contains the updated information of the specific spot group

Expand All
object

Request for updating existing spot group

AllowArchiving
boolean

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

AllowSpotArchiving
boolean

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

IsTemplateGroup
boolean

If true, the spot group is a template group. Default: false.

LocationId
integer (int32)

Unique ID of the location of the spot group

Minimum1.0
Maximum2147483647.0
Name
string

Name of the spot group

ParentId
integer (int32)

Unique ID of the parent of the spot group.

Minimum1.0
Maximum2147483647.0
Permissions
object

Permissions of the spot group

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

OK

Expand All
object

Spot group

AllowArchiving
boolean

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

AllowSpotArchiving
boolean

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

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the spot group

IsArchived
boolean

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

IsTemplateGroup
boolean

If true, the spot group is a template group. Default: false.

LocationId
integer (int32)

Unique ID of the location of the spot group

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the spot group

ParentId
integer (int32)

Unique ID of the parent of the spot group

Permissions
object

Permissions of the spot group

Read
boolean
Write
boolean
Create
boolean
Delete
boolean
EditTemplate
boolean
VideoExport
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