Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Treatment → Delete

AI-generated

Overview

This node operation deletes a specific Treatment record in the Magnet Customer system. It is useful in scenarios where a user needs to remove outdated or incorrect treatment data from their CRM or customer management platform. For example, if a treatment entry was created by mistake or is no longer relevant, this operation allows for its removal by specifying the Treatment ID.

Use Case Examples

  1. Deleting a treatment record by providing its unique Treatment ID to keep the database clean and up-to-date.
  2. Automating the removal of treatments that are no longer applicable to a customer or case.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request, either API Token or OAuth2.
Treatment ID The unique identifier of the treatment to be deleted. This is a required field for the delete operation.

Output

JSON

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

Dependencies

  • Requires an API key credential or OAuth2 token for authenticating requests to the Magnet Customer API.

Troubleshooting

  • Common issues include providing an invalid or non-existent Treatment ID, which will cause the API to return an error indicating the treatment could not be found.
  • Authentication failures due to incorrect or expired API tokens or OAuth2 tokens can prevent the operation from succeeding.
  • Network or API endpoint issues may cause request failures; ensure the API endpoint is reachable and the network connection is stable.

Discussion