AvantGuard - ClerkChat icon

AvantGuard - ClerkChat

AvantGuard - ClerkChat

Overview

This node operation allows bulk creation of inboxes and users within a specified team in a reseller context. It is designed to efficiently handle multiple creations in one request, which is useful for onboarding or managing large groups of users and their communication channels simultaneously. For example, a company reseller can use this node to quickly set up all necessary inboxes and user accounts for a new client team without repetitive manual input.

Properties

Name Meaning
Team Id The unique identifier of the team where the bulk inboxes and users will be created.
Data A JSON array containing objects that specify the details for each inbox and user to create in bulk.

Output

The output json field contains the response from the bulk creation API call. This typically includes information about the created inboxes and users, such as their IDs, statuses, or any errors encountered during creation. The exact structure depends on the external API's response format.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authentication with the external service.
  • Depends on the external AvantGuard ClerkChat API endpoint configured via node credentials.
  • The node uses a bundled OpenAPI specification to define its properties and requests.

Troubleshooting

  • Invalid Team Id: If the provided team ID does not exist or is incorrect, the API may return an error indicating the team was not found. Verify the team ID before running the node.
  • Malformed Data JSON: The Data property must be a valid JSON array of objects. Errors parsing this JSON will cause the request to fail. Ensure the JSON syntax is correct.
  • Authentication Errors: Missing or invalid API credentials will result in authorization failures. Confirm that the API key credential is correctly configured.
  • Partial Failures: Some items in the bulk data might fail while others succeed. Check the response for detailed error messages per item.

Links and References

Discussion