Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Treatment Type → Update

AI-generated

Overview

This node updates a Treatment Type resource in the Magnet Customer API. It is useful for scenarios where you need to modify the details of an existing treatment type, such as changing its name or other attributes. For example, a healthcare or wellness business might use this node to update the name of a treatment type to reflect new service offerings or corrections.

Use Case Examples

  1. Updating the name of a treatment type identified by its Type ID.
  2. Modifying attributes of a treatment type to keep the system data current.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request, either API Token or OAuth2.
Type ID The unique identifier of the treatment type to update. This is required to specify which treatment type to modify.
Name The new name to assign to the treatment type. This is optional and only used when updating the name.

Output

JSON

  • _id - The unique identifier of the updated treatment type.
  • name - The updated name of the treatment type.
  • otherProperties - Any other properties returned by the API related to the treatment type after update.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the Type ID is correct and corresponds to an existing treatment type; otherwise, the update will fail.
  • Verify that the authentication credentials (API Token or OAuth2) are valid and have sufficient permissions to update treatment types.
  • If the API returns an error, check the error message for details such as invalid parameters or network issues.

Discussion