Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Treatment → Update

AI-generated

Overview

This node updates an existing Treatment record in the Magnet Customer system. It is useful for scenarios where you need to modify details of a treatment such as its type, associated contact, subject, or name type. For example, updating the subject or contact information of a treatment after receiving new data.

Use Case Examples

  1. Updating the subject of a treatment to reflect a new appointment detail.
  2. Changing the contact associated with a treatment to correct an assignment error.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Treatment ID The unique identifier of the treatment to update. This is required to specify which treatment record to modify.
Type ID The identifier for the type of treatment. Used to specify or change the treatment type.
Contact ID The identifier of the contact associated with the treatment. Used to link or update the contact for the treatment.
Subject The subject or title of the treatment. Can be updated to reflect new or corrected information.
Name Type A string representing the name type associated with the treatment. Can be used to categorize or label the treatment.

Output

JSON

  • _id - The unique identifier of the updated treatment.
  • type - The type ID of the treatment after update.
  • contact - The contact ID associated with the treatment after update.
  • subject - The subject of the treatment after update.
  • nameType - The name type of the treatment after update.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the Treatment ID provided is valid and exists in the system; otherwise, the update will fail.
  • Check that the authentication method and credentials are correctly configured to avoid authorization errors.
  • If optional fields like Type ID, Contact ID, Subject, or Name Type are left empty, the treatment may not update as expected or may retain old values.

Discussion