Actions68
- Client Actions
- Agent Actions
- Asset Actions
- Field Info Actions
- Invoice Actions
- Site Actions
- Ticket Actions
- Ticket Status Actions
- Ticket Type Actions
- Timesheet Actions
- Timesheet Event Actions
- Webhook Actions
- Webhook Event Actions
Overview
This node integrates with the HaloPSA API to update an existing agent's details. It is useful in scenarios where you need to programmatically modify agent information such as contact details, department assignment, or permissions within a service management system. For example, you might use this node to deactivate an agent who has left the company, update their email address after a change, or assign them to a different team.
Properties
| Name | Meaning |
|---|---|
| Agent ID | The unique numeric identifier of the agent to update. |
| Update Fields | A collection of fields to update for the agent. Options include: |
| - Active: Whether the agent is active (true/false). | |
| - Department ID: Numeric ID of the department the agent belongs to. | |
| - Email Address: The agent's email address. | |
| - First Name: The agent's first name. | |
| - Is Admin: Whether the agent has administrative privileges (true/false). | |
| - Last Name: The agent's last name. | |
| - Login Name: The login username for the agent. | |
| - Name: The full name of the agent. | |
| - Phone Number: The agent's phone number. | |
| - Team ID: Numeric ID of the team the agent belongs to. |
Output
The node outputs JSON data representing the updated agent object as returned by the HaloPSA API. This typically includes all current properties of the agent after the update operation. The output does not include binary data.
Dependencies
- Requires an API key credential for authenticating with the HaloPSA API.
- The node depends on the HaloPSA API being accessible and the provided credentials having sufficient permissions to update agent records.
- No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
- Invalid Agent ID: If the specified Agent ID does not exist, the API will likely return an error indicating the resource was not found. Verify the Agent ID is correct.
- Insufficient Permissions: Errors related to authorization may occur if the API key lacks rights to update agents. Ensure the API key has appropriate scopes or roles.
- Validation Errors: Providing invalid values for fields (e.g., non-numeric IDs, malformed email addresses) can cause the API to reject the request. Double-check field formats.
- Network Issues: Connectivity problems with the HaloPSA API endpoint will result in request failures. Confirm network access and API availability.
Links and References
- HaloPSA API Documentation (general reference for API endpoints and data models)
- n8n Documentation on Creating Custom Nodes