AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

This node operation archives a company by its ID. It is useful in scenarios where you want to mark a company as archived or inactive within your system, effectively removing it from active lists without deleting the data permanently. For example, you might use this operation to archive companies that are no longer clients or partners but whose records need to be retained for historical or compliance reasons.

Properties

Name Meaning
Id The unique numeric identifier of the company to archive

Output

The node outputs JSON data representing the result of the archive operation on the specified company. This typically includes confirmation of the action and possibly the updated state of the company record after archiving. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authentication with the external service.
  • The node uses a base URL configured via credentials to connect to the relevant API endpoint.
  • Depends on the @avantguardllc/n8n-openapi-node package and an OpenAPI specification file (openapi.json) for request building and execution.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent company ID will likely result in an error response from the API.
    • Missing or incorrect API credentials can cause authentication failures.
    • Network connectivity problems may prevent successful API calls.
  • Error messages:

    • Authentication errors indicating invalid or missing credentials should be resolved by verifying the API key setup.
    • Not found errors suggest the provided company ID does not exist; verify the ID before retrying.
    • Timeout or network errors require checking internet connection and API availability.

Links and References

  • Refer to the external API documentation for details on the company archive endpoint.
  • Consult n8n documentation on setting up API credentials and using custom nodes.

Discussion