avanta icon

avanta

Consume avanta API

Actions8

Overview

This node integrates with the Avanta API to manage company-related data. Specifically, the Deactivate Company operation allows users to deactivate a company record by providing its Customer ID. This is useful in scenarios where a company account needs to be disabled or marked inactive without deleting it, such as when a customer relationship ends or a company no longer uses your services.

A practical example: After receiving a request to deactivate a client’s company account, this node can be used to update the status accordingly in Avanta’s system, ensuring that no further transactions or interactions occur under that company until reactivated.

Properties

Name Meaning
Return to Webhook Boolean flag indicating if the node should wait and return the response to a webhook node.
Customer ID The unique identifier of the company (customer) to be deactivated in the Avanta system.

Output

The node outputs JSON data representing the result of the deactivation request. This typically includes confirmation details such as success status, any messages from the API, and possibly the updated state of the company record.

If the "Return to Webhook" property is enabled, the output will be sent back through a connected webhook node, allowing synchronous response handling in workflows triggered by webhooks.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Avanta API via an API key credential configured in n8n.
  • The node depends on the Avanta API being accessible and the provided Customer ID being valid.
  • For returning responses directly to a webhook, a "Respond to Webhook" node must follow this node in the workflow.

Troubleshooting

  • Invalid Customer ID: If the provided Customer ID does not exist or is malformed, the API may return an error. Verify the ID before running the node.
  • API Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Connectivity problems with the Avanta API endpoint can cause timeouts or failures.
  • Missing Respond to Webhook Node: If "Return to Webhook" is enabled but no subsequent webhook response node exists, the workflow may hang or fail to return data properly.

Common error messages usually relate to authentication failure, invalid input parameters, or API unavailability. Checking credentials, input values, and network status typically resolves these issues.

Links and References

Discussion