Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Staff → Update

AI-generated

Overview

This node updates a staff member's information in the Magnet Customer system. It is useful for scenarios where you need to modify existing staff details such as name, email, phone numbers, role, workspace associations, and custom fields. For example, you can update a staff member's email address or assign them to new workspaces programmatically within an automation workflow.

Use Case Examples

  1. Updating a staff member's full name and email after a change in personnel.
  2. Assigning a new role to a staff member based on their updated responsibilities.
  3. Adding or modifying custom fields for a staff member to store additional information.

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 update. This is required to specify which staff member's data will be modified.
Nome Completo The full name of the staff member to update.
Email The email address of the staff member to update.
Telefone The phone number of the staff member to update (optional).
Telefone (WhatsApp) The WhatsApp phone number of the staff member to update (optional).
Role Name or ID The role ID to assign to the staff member. Can be selected from a list or specified via an expression.
IDs Do Workspace A list of workspace IDs to associate the staff member with.
Custom Fields Custom fields to add or update for the staff member. Each custom field requires a field name or ID and a value.

Output

JSON

  • _id - The unique identifier of the updated staff member.
  • fullname - The updated full name of the staff member.
  • email - The updated email address of the staff member.
  • phone - The updated phone number of the staff member.
  • whatsAppPhone - The updated WhatsApp phone number of the staff member.
  • role - The role ID assigned to the staff member.
  • workspaces - List of workspace IDs associated with the staff member.
  • customFields - Custom fields and their values associated with the staff member.

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure the Staff ID is correct and exists in the Magnet Customer system to avoid 'not found' errors.
  • Verify that the authentication credentials (API Token or OAuth2) are valid and have sufficient permissions to update staff data.
  • If custom fields are used, ensure the field IDs and values are valid and conform to the expected format.
  • Network or API rate limit issues may cause request failures; retry or check API limits if errors occur.

Discussion