Updates a specified class

Prev Next
Get
/updateclass

The UpdateClass command updates a specified class.

Security
API Key
Header parameter nameapi_key

All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".

Query parameters
id
stringRequired

The unique identifier of the class, as represented in your organization.

Example1223334444
name
stringRequired

The name of the class.

ExampleSample+Class
start
integer (int64) Required

When the class starts (in Unix epoch time).

Example1333267200
end
integer (int64) Required

When the class ends (in Unix epoch time).

Example1333299600
expires
integer (int64) Required

When labs can no longer be associated with the class (in Unix epoch time).

Example1335978000
instructorId
string

The unique identifier of the class instructor, as represented in your organization.

ExampleABC123
instructorFirstName
string

The first name of the class instructor.

ExampleDemo
instructorLastName
string

The last name of the class instructor.

ExampleInstructor
maxActiveLabInstances
integer (int32)

The maximum number of active lab instances than can exist concurrently within this class context. This is optional in most situations. However, it is required for classes that host shared environments. If a shared lab is launched against a class that doesn't have this value set, the launch will fail.

Example20
AvailableLabs
array of integer

An optional array of lab profile IDs. When provided, Skillable will know that these labs are available within the class. You do not need to set this value in order to launch labs against the class. This is useful when using Skillable to display a class attendance page, or when consuming shared class environments and you want the shared environment launch link to appear on the class monitor page.

Example[ "17390", "16980" ]
Responses
200

OK Response.

object
Success
boolean
Status
integer (int32)

Indicates the status of the API request.
0 = Error
1 = Success

Error
string | null

In the event of an error, this will contain a detailed error message.