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 operation, "Remove Users From Inbox" under the "Reseller" resource, allows users to remove one or more specified users from a particular inbox within a team. It is useful in scenarios where an administrator or reseller needs to manage user access to communication channels by revoking inbox permissions for certain users.
Practical examples include:
- Removing former employees from a team's shared inbox to prevent them from accessing ongoing conversations.
- Managing user roles dynamically by removing users who no longer require access to specific inboxes.
- Automating cleanup of user access when teams or projects change.
Properties
| Name | Meaning |
|---|---|
| Team Id | The unique identifier of the team that owns the inbox. |
| Inbox Id | The unique identifier of the inbox from which users will be removed. |
| User Ids | An array of user IDs representing the users to be removed from the specified inbox. |
Output
The node outputs JSON data reflecting the result of the removal operation. This typically includes confirmation of success or failure and may contain details about the updated state of the inbox or affected users. There is no indication that binary data is output by this node.
Dependencies
- Requires an API key credential for authentication with the AvantGuard ClerkChat service.
- Needs proper configuration of the base URL for the API endpoint via credentials.
- Depends on the external AvantGuard ClerkChat API to perform the user removal action.
Troubleshooting
- Missing or invalid Team Id or Inbox Id: Ensure these identifiers are correct and correspond to existing entities in the system.
- Invalid User Ids format: The
User Idsproperty must be a valid JSON array of user ID strings. Malformed JSON or incorrect data types can cause errors. - Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- API connectivity issues: Check network connectivity and the correctness of the API base URL.
- Error messages from API: These might indicate permission issues, non-existent users, or other domain-specific problems. Review the API response message for guidance.
Links and References
- AvantGuard ClerkChat API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes