ImmyBotInstall

Overview

The node is designed to interact with the "Person" resource of the ImmyBot API, specifically supporting the operation to delete a person by their ID. This operation is useful in scenarios where you need to programmatically remove a person's record from the system, such as cleaning up outdated or incorrect data.

A practical example would be an automation workflow that deletes a user profile after they unsubscribe or request data removal, ensuring compliance with data privacy regulations.

Properties

Name	Meaning
Person ID	The numeric identifier of the person to delete

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or relevant status information returned by the API. There is no indication that binary data is output by this node.

Dependencies

• Requires an API key credential for authentication with the ImmyBot service.
• The base URL for API requests is dynamically constructed using a subdomain value from credentials.
• The node expects the ImmyBot API to be accessible at https://{subdomain}.immy.bot/api/v1.
• The node sends and receives JSON-formatted data.

Troubleshooting

• Common issues:
  • Invalid or missing Person ID: Ensure the Person ID provided is correct and exists in the system.
  • Authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Network or connectivity problems: Confirm that the subdomain and API endpoint are reachable.
• Error messages:
  • Unauthorized or 401 errors typically indicate invalid or expired credentials.
  • 404 errors may mean the specified Person ID does not exist.
  • 400 errors could indicate malformed requests, such as missing required parameters.

Links and References

• ImmyBot API documentation (general reference for endpoints and authentication)
• n8n documentation on creating and configuring API credentials