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

Actions28

Overview

This node integrates with a PDF Generator API to perform various PDF-related operations, including workspace management. Specifically for the Workspace - Delete operation, it allows users to delete an existing workspace identified by a unique workspace identifier (such as an email-like string). This is useful in scenarios where you want to programmatically manage and clean up workspaces used for organizing templates and users within the PDF generation service.

Practical example:

  • Automatically remove obsolete or test workspaces from your PDF generation environment to keep it tidy and secure.
  • Integrate workspace deletion into workflows that manage user lifecycle or organizational changes.

Properties

Name Meaning
Workspace Identifier The unique identifier of the workspace to delete (e.g., user.example@domain.com).

Output

The output JSON object after deleting a workspace contains:

  • success: A boolean indicating if the deletion was successful (true).
  • message: A confirmation message string, e.g., "Workspace deleted successfully".
  • workspaceIdentifier: The identifier of the workspace that was deleted.

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 API key credential for authenticating with the PDF Generator API.
  • The node makes HTTP DELETE requests to the API endpoint /workspaces/{workspaceIdentifier}.
  • The base URL for the API defaults to https://us1.pdfgeneratorapi.com/api/v4 but can be configured via credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent workspace identifier will likely result in an error from the API.
    • Network connectivity issues or incorrect API credentials will cause authentication or request failures.

  • Error messages:

    • If the workspace identifier is missing or empty, the node will throw an error indicating the required parameter is missing.
    • API errors such as "Workspace not found" or permission denied will be returned from the API and surfaced by the node.

  • Resolution tips:

    • Ensure the workspace identifier is correctly spelled and exists.
    • Verify that the API key credential is valid and has permissions to delete workspaces.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion