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
The "Update Team" operation under the "Reseller" resource allows users to update details of an existing team by specifying its unique identifier and optionally modifying various attributes such as the team's name, tier, Microsoft tenant ID, SKU, and purchase order information. This node is useful in scenarios where a reseller or administrator needs to manage team configurations dynamically, for example, upgrading a team's subscription tier, renaming a team, or associating it with a specific Microsoft tenant.
Practical examples include:
- Changing a team's subscription from "Free" to "Starter" tier.
- Updating the purchase order reference associated with a team.
- Assigning a Microsoft tenant ID to integrate with Microsoft services.
Properties
| Name | Meaning |
|---|---|
| Team Id | The unique identifier of the team to be updated (required). |
| Additional Body Fields | Optional fields to update on the team: |
| - Name | New name for the team. |
| - Tier | Subscription tier of the team. Options: Fraud, Free, Starter, Unlimited, Mfa Nonvoip. |
| - Microsoft Tenant Id | Microsoft tenant ID to associate with the team. |
| - Tier Sku | SKU of the product being added to the team. |
| - Purchase Order | Purchase order number related to the team update. |
Output
The node outputs JSON data representing the updated team object returned from the API after the update operation. This typically includes the team's current properties reflecting any changes made. If the API supports binary data output, it would be summarized here, but based on the provided code and properties, the output is JSON only.
Dependencies
- Requires an API key credential for authentication to the external service managing teams.
- The base URL for the API is configured via credentials.
- The node depends on an OpenAPI client library (
@avantguardllc/n8n-openapi-node) to handle requests. - No additional environment variables are explicitly required beyond standard API credentials.
Troubleshooting
- Missing or invalid Team Id: The operation requires a valid team ID; ensure this is provided and correct.
- Invalid tier value: Only the specified tier options are accepted; using unsupported values will cause errors.
- Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
- Network or API errors: Check connectivity and API endpoint availability.
- Empty or malformed additional fields: When providing optional fields, ensure they conform to expected types and formats.
Common error messages might include:
- "Team not found" if the team ID does not exist.
- "Unauthorized" or "Forbidden" if API credentials lack permission.
- Validation errors indicating incorrect field values.
Resolving these usually involves verifying input parameters, checking credentials, and consulting API documentation for correct usage.
Links and References
- AvantGuard ClerkChat API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes
- OpenAPI specification reference for understanding request/response structures.