Skip to main content

Delete Enrollment

Deletes an enrollment in Canvas LMS.

This node is also exposed as an AI Agent tool.

This node has 1 input port and 1 output port.

Common Properties​

Every node shares these.

  • Name — the node's display name on the canvas.
  • Color — the node's colour on the canvas.
  • Delay Before (sec) — wait this long before the node runs.
  • Delay After (sec) — wait this long after the node runs.
  • Continue On Error — carry on instead of failing the flow. Defaults to false.
info

When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.

Inputs​

PropertyFieldDescription
Client IDinClientIDClient ID from Connect node
Course IDinCourseIDThe course to remove enrollment from
Enrollment IDinEnrollmentIDThe enrollment ID to delete

Outputs​

PropertyFieldDescription
Enrollment IDoutEnrollmentIDID of the removed enrollment

Options​

PropertyFieldDescription
ActionoptTaskWhat to do with the enrollment One of: conclude, delete, inactivate, deactivate.
CredentialsoptCredentialsCanvas API credentials

Requirements​

  • A Client ID from this package's Connect node, unless you set credentials directly on this node.
  • Canvas API Token — API access token for Canvas LMS authentication
    • url — Canvas URL (text, required). Your Canvas instance URL (without trailing slash)
    • value — API Token (password, required). API access token from Canvas account settings

Store these in a Vault and reference the vault item from the node, rather than typing the secret into the property.

List Enrollments · Create Enrollment

Elsewhere in the package: Connect · Disconnect · List Courses · Get Course · List Assignments · Get Assignment · Create Assignment · Update Assignment · Delete Assignment · List Course Users and 9 more

See also​