Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

This node integrates with the Magnet Customer API to manage various resources including staff members. Specifically, the Staff - Delete operation allows users to delete a staff member by their unique ID. This is useful in scenarios where you need to automate the removal of staff records from your CRM or customer management system, for example when an employee leaves the company or changes roles.

Practical examples:

  • Automatically removing staff members from the system based on HR updates.
  • Cleaning up inactive or obsolete staff entries as part of data maintenance workflows.
  • Integrating with other systems to synchronize staff deletions.

Properties

Name Meaning
Authentication Method used to authenticate API requests. Options: API Token, OAuth2.
Staff ID The unique identifier of the staff member to delete. This is required to specify which staff record to remove.

Note: There are several hidden properties related to "Life Cycle" and "Source" in the provided JSON, but they are not relevant for the Staff Delete operation and appear duplicated or unused here.

Output

The output of this operation is a JSON object representing the result of the delete request. Typically, this will include confirmation that the staff member was deleted or an error message if the deletion failed.

The node does not output binary data.

Example output JSON might look like:

{
  "success": true,
  "message": "Staff member deleted successfully",
  "staffId": "12345"
}

Or in case of failure:

{
  "error": "Staff member not found"
}

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires valid authentication credentials configured in n8n, either via an API token or OAuth2.
  • The node depends on internal helper functions to make HTTP requests to the Magnet Customer API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Staff ID: Ensure the Staff ID provided exists and is correct.
    • Authentication errors: Verify that the API token or OAuth2 credentials are correctly set up and have sufficient permissions.
    • Network or API downtime: Check connectivity and Magnet Customer API status.
  • Common error messages:

    • "Staff member not found": The specified Staff ID does not exist; verify the ID.
    • "Unauthorized" or "Authentication failed": Credentials are invalid or expired; reauthenticate.
    • "Failed to delete staff": General failure; check API response details for more info.

Resolving these usually involves verifying input parameters, checking credentials, and ensuring the API service is operational.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion