PandaDoc icon

PandaDoc

Consume PandaDoc API

Overview

This node integrates with the PandaDoc API to manage folders within a PandaDoc account. Specifically, the Folder Delete operation allows users to delete a specified folder from their PandaDoc documents management system.

Common scenarios where this node is beneficial include:

  • Automating document organization workflows by removing obsolete or empty folders.
  • Cleaning up shared or private folders programmatically as part of document lifecycle management.
  • Integrating with other systems to maintain synchronized folder structures by deleting folders no longer needed.

For example, a user might set up an automation that deletes folders after all documents inside have been archived elsewhere, ensuring the PandaDoc workspace stays tidy.

Properties

Name Meaning
Authentication Method used to authenticate with PandaDoc API. Options: API Key, OAuth2.
Folder The folder to delete. Can be selected from a searchable list of existing folders or provided directly by its ID.

The Folder property supports two modes for specifying the folder:

  • From List: Search and select a folder by name from existing folders (including "Root (No Folder)").
  • By ID: Provide the folder's unique identifier string directly (must match a regex pattern of at least 16 alphanumeric or hyphen characters).

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be confirmation data returned by the PandaDoc API indicating successful deletion or details about the deleted folder.

If an error occurs during deletion, the output JSON will contain an error field describing the issue.

No binary data output is produced by this operation.

Dependencies

  • Requires a valid PandaDoc API authentication credential, either via an API key or OAuth2 token.
  • The node depends on the PandaDoc REST API endpoint /documents/folders for folder management.
  • Proper configuration of the authentication credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Common Issues:

    • Invalid Folder ID format: Ensure the folder ID matches the required pattern (at least 16 alphanumeric or hyphen characters).
    • Folder not found: Selecting a folder that does not exist or has already been deleted will cause errors.
    • Insufficient permissions: The API key or OAuth2 token must have rights to delete folders.
    • Network or API errors: Temporary connectivity issues or PandaDoc service outages can cause failures.
  • Error Messages:

    • "PandaDoc API error: <message>": Indicates an error response from the PandaDoc API. Check the message for specifics such as invalid credentials, missing folder, or permission denied.
    • Validation error for Folder ID: If the ID does not match the regex, the node will reject it before making the API call.
  • Resolution Tips:

    • Verify the folder exists and the ID is correct.
    • Confirm the authentication credentials are valid and have appropriate scopes.
    • Retry after some time if encountering transient network errors.
    • Use the "From List" mode to avoid manual ID entry errors.

Links and References

Discussion