The Companies API icon

The Companies API

Access company data, enrichment, analytics and more using The Companies API

Overview

This node integrates with The Companies API to manage company-related data. Specifically, the "Delete list" operation under the "Lists" resource allows users to delete a company list by its ID. This is useful for maintaining and organizing company lists by removing outdated or unnecessary lists.

Practical scenarios include:

  • Cleaning up old marketing or sales target lists.
  • Removing test or temporary lists created during data processing.
  • Automating list management workflows where lists are deleted after certain conditions are met.

Properties

Name Meaning
List ID The numeric identifier of the list to be deleted.

Output

The node outputs JSON data representing the response from the API after attempting to delete the specified list. The structure typically contains confirmation of deletion or relevant status information returned by The Companies API.

If an error occurs (e.g., invalid List ID), the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an API token credential for authenticating requests to The Companies API.
  • The node uses The Companies API SDK internally to perform operations.
  • Proper configuration of the API token in n8n credentials is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent List ID will cause the API to return an error.
    • Missing or incorrect API token credential will result in authentication failures.
    • Network connectivity issues can prevent successful API calls.
  • Error messages:

    • "Unknown operation: deleteList": Indicates the operation name is not recognized; ensure the operation parameter is correctly set.
    • "SDK method deleteList not found": Internal error indicating the SDK does not support this method; likely a misconfiguration or version mismatch.
    • API errors returned in the JSON error field usually indicate problems like invalid List ID or permission issues.
  • Resolutions:

    • Verify the List ID is correct and exists.
    • Confirm the API token credential is valid and has required permissions.
    • Check network connectivity and retry.
    • Enable "Continue on Fail" if you want the workflow to proceed despite individual item errors.

Links and References

Discussion