PDF Generator API icon

PDF Generator API

Generate PDFs, manage templates, convert HTML/URLs to PDF, and perform PDF operations like watermarking, encryption, and optimization

Actions13

Overview

This node integrates with a PDF Generator API to manage workspaces, which are organizational units for templates and users. Specifically, the Workspace - Delete operation allows users to delete an existing workspace by specifying its unique identifier. This is useful in scenarios where you want to clean up or remove obsolete or unused workspaces from your PDF generation environment.

Practical example:

  • You have multiple teams using different workspaces for managing their PDF templates and documents. When a team disbands or no longer needs access, you can automate the deletion of their workspace to maintain a tidy environment and control access.

Properties

Name Meaning
Workspace Identifier The unique identifier of the workspace to delete (e.g., an email-like string such as user.example@domain.com). This identifies which workspace will be removed.

Output

The output JSON object after a successful delete operation contains:

  • success: A boolean indicating if the deletion was successful (true).
  • message: A confirmation message string, e.g., "Document deleted successfully" (in this context, it will confirm workspace deletion).
  • publicId (or equivalent): The identifier of the deleted workspace.

Example output JSON:

{
  "success": true,
  "message": "Workspace deleted successfully",
  "workspaceIdentifier": "user.example@domain.com"
}

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the PDF Generator API service.
  • Requires an API key credential configured in n8n for authentication with the PDF Generator API.
  • The base URL for the API defaults to https://us1.pdfgeneratorapi.com/api/v4 but can be overridden by credentials configuration.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent workspace identifier will likely result in an error from the API.
    • Network or authentication failures due to missing or incorrect API credentials.
    • Attempting to delete a workspace that is currently in use or linked to active templates might cause errors depending on API restrictions.

  • Error messages and resolutions:

    • "Workspace not found": Verify the workspace identifier is correct and exists.
    • "Unauthorized" or authentication errors: Check that the API key credential is correctly set up and has sufficient permissions.
    • "The operation 'delete' is not supported for resource 'workspace'": This indicates a misconfiguration or unsupported operation; ensure the node parameters are correctly set to Resource = Workspace and Operation = Delete.

Links and References

This summary focuses solely on the Workspace resource's Delete operation as requested, based on static analysis of the provided source code and property definitions.

Discussion