DELETE /api/v1/groups/{group_id}
Delete a group, and all its subgroups.
Returns :
- In case of success, an empty response code 204 (No Content) in accordance with RFC 7231.
- In case of error, an error code.
Errors
-
500 ("Cannot delete group"): the group or one of its subgroups has an active integration. Manually disable the integration in the Web platform before attempting to delete.
-
400 ("group_not_found"): group ID doesn’t exist in the platform.
-
400 ("cannot remove root group"): group ID is that of the platform group. If you want to delete the platform, contact your Client Success Partner (CSP).
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
group_id |
String | Yes |
group's id |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
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 |
|---|---|---|---|
company |
String | No | |
apiKey |
String | 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.