Actions33
- Public Actions
- Public Admin Actions
- Reseller Actions
- Create New Team
- Get Team Information
- Update Team
- Remove Team From Reseller
- Update Team Avatar
- Create Team Bulk Inboxes And Users
- Get Team Users
- Add User To Team
- Remove Users From Team
- Get Team Inboxes
- Remove Team Inboxes
- Create Team Bulk Inboxes
- Assign Users To Inbox
- Remove Users From Inbox
- Get Team Whitelist Domains
- Create Team Whitelisted Domain
- Remove Team Whitelisted Domain
- Create Reseller
- Import Team Users
- Get Import Team Users Job Status
Overview
This node integrates with the AvantGuard ClerkChat service to add a new user to the chat system via its Public Admin API. It is designed for administrators or automation workflows that need to programmatically create users in ClerkChat, such as onboarding new team members or synchronizing user data from other systems.
Typical use cases include:
- Automatically adding support agents or managers to the ClerkChat workspace when they join an organization.
- Bulk importing users into ClerkChat with predefined roles.
- Integrating user creation into broader customer support or CRM workflows.
Properties
| Name | Meaning |
|---|---|
| The email address of the user to add. This is required and uniquely identifies the user. | |
| Additional Body Fields | Optional extra fields to specify additional user details: |
| - First Name | The first name of the user to add. |
| - Last Name | The last name of the user to add. |
| - Role | The role assigned to the user within ClerkChat. Options are: |
| - Workspace Owner | |
| - Admin | |
| - Manager | |
| - Agent | |
| - Member |
Output
The node outputs JSON data representing the response from the ClerkChat API after attempting to add the user. This typically includes details about the newly created user such as their ID, email, name, role, and status.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard ClerkChat API.
- The base URL for the API is configured via credentials.
- The node depends on the
@avantguardllc/n8n-openapi-nodepackage for OpenAPI integration.
Troubleshooting
Common Issues:
- Missing or invalid API authentication token will cause authorization errors.
- Providing an email already associated with an existing user may result in a conflict error.
- Omitting the required "Email" property will prevent the request from being sent.
Error Messages:
- 401 Unauthorized: Check that the API key credential is correctly set and has proper permissions.
- 409 Conflict: The user with the specified email already exists; consider updating instead of adding.
- 400 Bad Request: Verify that all required fields are provided and valid, especially the email format.
Links and References
- AvantGuard ClerkChat API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes