Actions115
- 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
- Enroll Actions
- Email Campaign Excluded Plan Actions
- Email Campaign List Actions
- Email Campaign Plan Actions
- Email List Actions
- MindzPay Account Actions
- MindzPay Invoice Actions
- MindzPay Payment Actions
- MindzPay Subscription Actions
- Subscription Actions
- Team Actions
- User Actions
Overview
The node interacts with the "Enroll" resource of the Mindz API, specifically supporting a "Toggle" operation. This operation allows users to activate or deactivate an enrollment by toggling its active status. It is useful in scenarios where you need to enable or disable user enrollments dynamically without deleting them, such as temporarily suspending access or reactivating a previously inactive enrollment.
Practical examples include:
- Activating a user's enrollment after payment confirmation.
- Deactivating an enrollment due to inactivity or policy violations.
- Managing enrollment statuses in bulk workflows for course management.
Properties
| Name | Meaning |
|---|---|
| Enroll ID | The unique identifier of the enrollment to be toggled (activated or deactivated). |
| Active | Boolean flag indicating whether to set the enrollment as active (true) or inactive (false). |
Output
The output JSON contains the result of the toggle operation on the specified enrollment. Typically, it will include details about the enrollment's updated state, such as its ID and current active status. The exact structure depends on the Mindz API response but generally confirms the success of the toggle action and reflects the new active state.
No binary data output is expected from this operation.
Dependencies
- Requires an API key credential for authenticating with the Mindz API.
- The node depends on the Mindz OAuth2 authentication setup within n8n.
- Network connectivity to the Mindz API endpoint is necessary.
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 or OAuth2 credentials are valid and have sufficient permissions.
- Network or API downtime: Check connectivity and Mindz service status.
Error messages:
- "Enrollment not found": The given Enroll ID does not exist; verify the ID.
- "Unauthorized" or "Authentication failed": Credentials are invalid or expired; update or reauthenticate.
- "Invalid parameter": The 'active' property might be missing or incorrectly typed; ensure it is a boolean.
Resolving these typically involves verifying input parameters, refreshing credentials, and checking API availability.
Links and References
- Mindz API Documentation (hypothetical link)
- n8n OAuth2 Credential Setup Guide: https://docs.n8n.io/credentials/oauth2/
- n8n Node Development Documentation: https://docs.n8n.io/integrations/creating-nodes/