DELETE /api/v1/externalContents/groups/{groupId}/externalPlatforms/{externalPlatform}/courses
Delete external contents.
Request Body
Type: application/json
| Name | Type | Mandatory | Description |
|---|---|---|---|
externalIds | Array of string | Yes | IDs of the external courses, as identified by the external provider |
Returns
Returns the status for each externalCourse and a global status report:
totalCoursesArchived: Total number of external courses deletedtotalArchiveErrors: Total number of external that could not be deletedexternalCoursesStatus: An array ofexternalCoursesStatusobjectsexternalId:externalIdof theexternalCoursethat was processedstatus: HTTP status code for the import of theexternalCourse:204: externalCourse archived successfully404: externalCourse archive fails because theexternalIdcannot be found
message: Description of the HTTP status code:External course archived: HTTP status code 204externalId not found: HTTP status code 404
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
externalPlatform |
String | Yes |
Name of the external platform to which the external content is attached |
groupId |
String | Yes |
ID of the group where external contents were imported |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
externalIds[] |
Array | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.