Actions57
- Course Actions
- User Actions
- Assignment Actions
- Module Actions
- Page Actions
- Discussion Actions
- File Actions
- Announcement Actions
- Quiz Actions
- Submission Actions
- Enrollment Actions
- Group Actions
- Rubric Actions
Overview
This node integrates with the Canvas LMS API to manage groups within courses. Specifically, the "Delete" operation for the "Group" resource allows users to delete a group identified by its Group ID within a specified course. This is useful in scenarios where groups are no longer needed or were created by mistake and need to be removed from a course.
Practical examples:
- Removing a study group that has completed its purpose.
- Cleaning up test or temporary groups after a course ends.
- Automating group lifecycle management as part of course administration workflows.
Properties
| Name | Meaning |
|---|---|
| Group ID | The unique identifier of the group to delete. |
Output
The output JSON contains a data field which holds the response from the Canvas LMS API after attempting to delete the group. Typically, this will be an empty object or confirmation of deletion depending on the API's response.
Example output structure:
{
"data": {}
}
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Canvas LMS API.
- The node expects the base URL and access token for the Canvas LMS instance to be configured in the credentials.
- Network connectivity to the Canvas LMS API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing Group ID: The API call will fail if the Group ID is incorrect or not provided.
- Insufficient permissions: The API user must have rights to delete groups in the specified course.
- Network or authentication errors: Ensure the API key and URL are correctly set and valid.
Error messages:
"Error in "group" operation "delete": <message>": Indicates failure during the delete request; check the message for details such as "Not Found" or "Unauthorized".- Node API errors typically wrap HTTP errors; verify the Group ID and credentials.
Resolution:
- Verify the Group ID exists and belongs to the correct course.
- Confirm the API key has sufficient privileges.
- Check network connectivity and API endpoint correctness.