ImmyBot icon

ImmyBot

ImmyBot Node

Overview

The node provides functionality to update a tenant entity within the ImmyBot system. It allows users to modify key attributes of an existing tenant such as its name, slug (a URL-friendly identifier), parent tenant relationship, and whether it is designated as a Managed Service Provider (MSP). This operation is useful in scenarios where organizational structures or tenant details need to be maintained or corrected dynamically, for example, updating tenant information after a rebranding or restructuring.

Properties

Name Meaning
ID The unique numeric identifier of the tenant to edit.
Name The new or updated name of the tenant.
Slug A URL-friendly string identifier for the tenant, used in URLs or references.
Parent Tenant ID Optional numeric ID of another tenant that acts as the parent in a hierarchical setup.
Is MSP Boolean flag indicating if the tenant is a Managed Service Provider (true/false).

Output

The node outputs JSON data representing the updated tenant object as returned by the ImmyBot API. This typically includes the tenant's current state after the update, reflecting all changes made. There is no indication of binary data output.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials.
  • Needs the subdomain credential parameter to construct the base URL for API requests.
  • Depends on the ImmyBot API being accessible at https://{subdomain}.immy.bot/api/v1.

Troubleshooting

  • Invalid Tenant ID: If the provided tenant ID does not exist, the API will likely return an error. Verify the ID before attempting an update.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the OAuth2 credentials are correctly set up.
  • Slug Conflicts: Using a slug already assigned to another tenant may result in errors. Use unique slugs.
  • Parent Tenant Issues: Specifying a non-existent parent tenant ID can cause errors; verify parent tenant IDs beforehand.
  • Network or API Downtime: Connectivity issues with the ImmyBot API endpoint will prevent updates. Check network status and API availability.

Links and References

Discussion