Deletes a specified class

Prev Next
Get
/deleteclass

The DeleteClass command deletes 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.

Example4449999
Responses
200

OK Response.

Example of successfully deleting an existing class
{
  "Success": true,
  "Error": null,
  "Status": 1
}
Example of trying to delete a class that does not exist
{
  "Error": "Class not found",
  "Status": 0
}
object
Success
boolean

Returns with true if the class was successfully deleted. This element will only be returned for successful class deletions.
true = Success

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.