ImmyBot icon

ImmyBot

ImmyBot Node
Join our community

Actions24

Overview

The node provides integration with the ImmyBot API, specifically allowing management of tenants within the system. The "Tenant - Update" operation enables users to modify existing tenant records by specifying their ID and updating properties such as name, slug, parent tenant, and whether the tenant is a Managed Service Provider (MSP).

This node is beneficial in scenarios where organizations need to programmatically maintain hierarchical tenant structures or update tenant metadata without manual intervention. For example, an MSP managing multiple client tenants can automate updates to tenant details as organizational changes occur.

Properties

Name Meaning
ID The unique numeric identifier of the tenant to edit (required).
Name The new or updated name for the tenant (required).
Slug A URL-friendly identifier string for the tenant, used in URLs or references.
Parent Tenant ID Numeric ID of the parent tenant, establishing a hierarchy (optional).
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 returned from the ImmyBot API after a successful update operation. This typically includes the tenant's current state with all its properties such as ID, name, slug, parent tenant ID, MSP status, and possibly timestamps or metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential configured for authentication with the ImmyBot service.
  • The node uses the subdomain provided in credentials to construct the base URL for API requests.
  • Network access to the ImmyBot API endpoint (https://{subdomain}.immy.bot/api/v1) is necessary.

Troubleshooting

  • Invalid Tenant ID: If the specified 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 authentication failures. Ensure the API key credential is correctly set up.
  • Validation Errors: Providing invalid values for fields like slug (e.g., containing spaces or special characters) may result in errors. Follow the expected format for each property.
  • Network Issues: Connectivity problems to the ImmyBot API endpoint will prevent the node from functioning. Check network settings and firewall rules.

Links and References

Discussion