Actions116
- Course Actions
- Bundle Actions
- Course Grade Actions
- Course Grade Detail Actions
- Course Teacher Actions
- Email Actions
- Email Campaign Actions
- Email Campaign Course Actions
- Email Campaign Excluded Course Actions
- Email Campaign Excluded List Actions
- Email Campaign Excluded Plan Actions
- Email Campaign List Actions
- Email Campaign Plan Actions
- Email List Actions
- Enroll Actions
- MindzPay Account Actions
- MindzPay Invoice Actions
- MindzPay Payment Actions
- MindzPay Subscription Actions
- Subscription Actions
- Team Actions
- User Actions
Overview
The "Enroll" resource with the "Toggle" operation in this node allows users to activate or deactivate a specific enrollment by its ID. This is useful in scenarios where you need to enable or disable user access or participation in a course, program, or service without deleting the enrollment record. For example, an administrator might temporarily suspend a student's enrollment or reactivate it later.
Properties
| Name | Meaning |
|---|---|
| Enroll ID | The unique identifier of the enrollment to be toggled (activated or deactivated). |
| Active | A boolean flag indicating whether to set the enrollment as active (true) or inactive (false). |
Output
The output JSON will typically contain the result of the toggle action on the enrollment. This may include confirmation of the new status of the enrollment or details about the updated enrollment record. The exact structure depends on the API response but generally confirms success and shows the current active state.
No binary data output is expected from this operation.
Dependencies
- Requires an API key credential for authentication with the Mindz API.
- The node depends on the Mindz API service being accessible and properly configured.
- No additional environment variables are explicitly required beyond the API credentials.
Troubleshooting
Common Issues:
- Invalid or missing Enroll ID: Ensure the provided enrollment ID exists and is correctly formatted.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Network or API downtime: Check connectivity and Mindz API status.
Error Messages:
- "Enrollment not found": The specified Enroll ID does not exist; verify the ID.
- "Unauthorized" or "Authentication failed": The API key credential is invalid or expired; update credentials.
- "Failed to toggle enrollment": Could indicate server issues or invalid parameters; review inputs and retry.
Links and References
- Mindz API Documentation (general): https://docs.mindz.com/api (example placeholder link)
- n8n Documentation on Custom Nodes: https://docs.n8n.io/integrations/creating-nodes/