Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

This node integrates with the Magnet Customer API to perform various operations on different resources, including workspaces. Specifically, for the Workspace - Delete operation, it allows users to delete a workspace by specifying its unique identifier. This is useful in scenarios where you want to programmatically remove obsolete or unused workspaces from your Magnet Customer account as part of an automated workflow.

Practical examples include:

  • Automatically cleaning up test or temporary workspaces after a project ends.
  • Removing workspaces that are no longer needed based on certain business rules.
  • Integrating workspace management into broader CRM automation pipelines.

Properties

Name Meaning
Authentication Method of authentication to use: either "API Token" or "OAuth2".
Workspace ID The unique identifier of the workspace to delete. This is required to specify which workspace to remove.

Note: The provided JSON includes several hidden properties related to contact life cycle and source, but these are not relevant for the Workspace Delete operation and appear duplicated; they can be ignored here.

Output

The output of the node is a JSON array containing the response from the Magnet Customer API after attempting to delete the specified workspace. Typically, this will include confirmation of deletion or any error messages returned by the API.

If the deletion is successful, the output JSON might be empty or contain a success message depending on the API's response format.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires configuration of either an API token credential or OAuth2 credential within n8n for authentication.
  • The node uses internal helper functions to make HTTP requests to the Magnet Customer API endpoints.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Workspace ID will likely result in an error from the API indicating the workspace could not be found.
    • Insufficient permissions or incorrect authentication credentials may cause authorization errors.
    • Network connectivity issues can prevent the node from reaching the Magnet Customer API.

  • Error messages and resolutions:

    • "Workspace not found": Verify the Workspace ID is correct and exists in your Magnet Customer account.
    • "Unauthorized" or "Authentication failed": Check that the API token or OAuth2 credentials are correctly configured and have the necessary permissions.
    • "Request timeout" or network errors: Ensure stable internet connection and that the Magnet Customer API endpoint is reachable.

  • Enabling "Continue On Fail" in the node settings can help workflows proceed even if some deletions fail, allowing partial processing.

Links and References

Discussion