ImmyBot

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 remove a person's record from the system, such as cleaning up outdated or incorrect data.

A practical example would be automating the removal of a user who has unsubscribed or whose data must be deleted for compliance reasons.

Properties

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

Output

The node outputs JSON data representing the result of the delete operation. Typically, this might include confirmation of deletion or 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 (OAuth2).
• Needs configuration of the subdomain for the ImmyBot API endpoint.
• The base URL for requests is dynamically constructed using the provided subdomain.
• The node sends and expects JSON-formatted data.

Troubleshooting

• Common issues:

  • Invalid or missing Person ID will cause the delete operation to fail.
  • Incorrect or missing API credentials will prevent successful authentication.
  • Misconfigured subdomain will lead to request failures due to invalid URLs.

• Error messages:

  • Authentication errors typically indicate problems with the OAuth2 token or credentials.
  • Not found errors may occur if the Person ID does not exist.
  • Validation errors if the Person ID is not provided or is of the wrong type.

To resolve these, ensure the Person ID is correct and exists, verify API credentials are valid and active, and confirm the subdomain is properly set in the node's credentials.

Links and References

• ImmyBot API documentation (refer to the official site for detailed API endpoints and authentication setup).