ImmyBot icon

ImmyBot

ImmyBot Node

Overview

This node allows you to delete one or more tenants by specifying their IDs. It is useful in scenarios where you need to programmatically remove tenant records from the ImmyBot system, such as cleaning up unused tenants or automating tenant lifecycle management.

For example, if you have a list of tenant IDs that are no longer active or needed, you can pass them as a JSON array to this node to delete all those tenants in a single operation.

Properties

Name Meaning
IDs A JSON array of tenant IDs to delete. For example: ["297", "298"]. This property is required and expects a string representing a JSON array of tenant ID strings.

Output

The node outputs data on the main output channel. The exact structure of the json output is not explicitly shown in the provided code, but typically for a delete operation it would return confirmation of deletion or status messages per tenant ID.

No binary data output is indicated or expected.

Dependencies

  • Requires an API key credential for authentication (OAuth2-based).
  • Connects to the ImmyBot API at a base URL constructed from the user's subdomain.
  • The node sends requests with JSON content type and expects JSON responses.

Troubleshooting

  • Invalid JSON in IDs: If the input for IDs is not a valid JSON array string, the node will likely fail. Ensure the IDs are formatted correctly as a JSON array of strings.
  • Authentication errors: Missing or invalid API credentials will cause authentication failures. Verify that the OAuth2 API credentials are configured properly.
  • Non-existent tenant IDs: Attempting to delete tenant IDs that do not exist may result in error responses from the API. Confirm the tenant IDs before deletion.
  • API connectivity issues: Network problems or incorrect subdomain configuration can prevent successful API calls.

Links and References

  • ImmyBot API documentation (for tenant management and deletion endpoints) — consult your service provider's official API docs.
  • n8n OAuth2 credential setup guide for configuring API authentication.

Discussion