Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

This node integrates with the Magnet Customer API to update staff member information. It allows users to modify details such as full name, email, phone numbers, role assignments, workspace associations, and custom fields for a specific staff member identified by their Staff ID.

Common scenarios include:

  • Keeping staff records up-to-date in a CRM or customer management system.
  • Automating updates to staff contact details or roles based on external triggers.
  • Synchronizing staff data between Magnet Customer and other platforms.

Practical example:

  • When a staff member's role changes within an organization, this node can update their role ID accordingly.
  • Adding or modifying custom fields for staff members to capture additional metadata relevant to business processes.

Properties

Name Meaning
Authentication Method of authentication: "API Token" or "OAuth2".
Staff ID The unique identifier of the staff member to update (required).
Nome Completo Full name of the staff member.
Email Email address of the staff member.
Telefone Phone number of the staff member (optional).
Telefone (WhatsApp) WhatsApp phone number of the staff member (optional).
Role Name or ID Role assigned to the staff member. Choose from a list or specify an ID via expression.
IDs Do Workspace List of Workspace IDs to associate the staff member with. Multiple values allowed.
Custom Fields Collection of custom fields to set for the staff member. Each includes a field name or ID and its value.

Output

The node outputs JSON data representing the updated staff member record as returned by the Magnet Customer API. This typically includes all standard and custom fields reflecting the new state after the update operation.

No binary data output is involved.

Dependencies

  • Requires connection to the Magnet Customer API.
  • Supports two authentication methods: API Token or OAuth2.
  • Requires appropriate credentials configured in n8n for authentication.
  • Uses internal helper functions to fetch options like roles and custom fields dynamically.

Troubleshooting

  • Missing or invalid Staff ID: The update operation requires a valid Staff ID. Ensure the ID exists and is correctly provided.
  • Authentication errors: Verify that the API token or OAuth2 credentials are correctly configured and have sufficient permissions.
  • Invalid role or workspace IDs: When specifying role or workspace IDs, ensure they exist in the Magnet Customer system.
  • Custom field errors: Custom fields must be specified using valid field names or IDs. Incorrect references may cause failures.
  • API rate limits or connectivity issues: Network problems or API limits may cause request failures; check connectivity and API usage quotas.

Error messages typically reflect these issues and should guide corrective actions such as verifying input parameters or credentials.

Links and References

Discussion