Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Staff → Delete

AI-generated

Overview

This node deletes a staff member from the Magnet Customer system using the staff member's ID. It is useful in scenarios where you need to remove staff records, such as when an employee leaves the organization or when cleaning up outdated staff data.

Use Case Examples

  1. Deleting a staff member by providing their unique Staff ID to remove them from the system.
  2. Automating staff management workflows by programmatically deleting staff entries based on certain conditions.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Staff ID The unique identifier of the staff member to delete. This is a required field.

Output

JSON

  • json - The JSON response from the API after attempting to delete the staff member, typically indicating success or failure.

Dependencies

  • Requires an API key credential or OAuth2 token for authentication to access the Magnet Customer API.

Troubleshooting

  • Ensure the Staff ID provided is correct and exists in the system; otherwise, the delete operation will fail.
  • Check that the authentication credentials (API Token or OAuth2) are valid and have sufficient permissions to delete staff records.
  • If the node throws an error, verify network connectivity and API endpoint availability.
  • If 'continueOnFail' is enabled, errors will be returned in the output JSON with an error message property.

Discussion