ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The Delete Agent From Account operation for the Agents resource in this custom n8n node allows you to remove a specific agent from a given account within ChatWoot. This is useful for managing team members, especially when an agent leaves your organization or should no longer have access to a particular account.

Practical scenarios:

  • Offboarding employees by removing their agent access.
  • Cleaning up unused or test agents from accounts.
  • Automating user management workflows in customer support environments.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account.
Id Number The ID of the agent to be deleted.

Both properties are required and must be provided for the operation to execute.

Output

  • The output will be a JSON object reflecting the result of the delete operation. Typically, this may include:
    • A success status or confirmation message.
    • Any error information if the deletion fails.

Example output:

{
  "success": true,
  "message": "Agent deleted successfully."
}

Note: The exact structure depends on the ChatWoot API response.

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Credentials: You must configure chatwootApi credentials in n8n, including the base URL and authentication token.
  • n8n Configuration: Ensure the node has network access to the ChatWoot server.

Troubleshooting

Common issues:

  • Invalid Account Id or Agent Id: If either ID does not exist, the operation will fail. Double-check the values.
  • Insufficient Permissions: The API key used must have permission to delete agents from the specified account.
  • Network/Connection Errors: Ensure n8n can reach the ChatWoot API endpoint.

Possible error messages:

  • "404 Not Found": The account or agent was not found. Verify the IDs.
  • "401 Unauthorized": Invalid or missing API credentials. Check your n8n credential setup.
  • "403 Forbidden": The API key lacks necessary permissions.

Links and References

Discussion