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

Actions21

Workspace → Delete

AI-generated

Overview

This node operation deletes a workspace identified by a unique workspace identifier. It is useful for managing and organizing workspaces by removing those that are no longer needed. For example, an organization can use this operation to delete a workspace associated with a specific user or project when it is no longer active.

Use Case Examples

  1. Deleting a workspace by specifying its unique identifier such as an email address or custom ID.
  2. Automating workspace cleanup in an organization by deleting unused or obsolete workspaces.

Properties

Name Meaning
Workspace Identifier The unique identifier of the workspace to delete, e.g., user.example@domain.com. This is required to specify which workspace to delete.

Output

JSON

  • success - Indicates if the workspace was successfully deleted (true/false).
  • message - Confirmation message about the deletion status.
  • workspaceIdentifier - The identifier of the workspace that was deleted.

Dependencies

  • Requires an API key credential for the PDF Generator API to authenticate requests.

Troubleshooting

  • Ensure the workspace identifier is correctly specified and URL-encoded if it contains special characters.
  • Common error: 'The operation "delete" is not supported for resource "workspace"' indicates a mismatch in resource or operation parameters.
  • API errors related to authentication or permissions may occur if the API key credential is invalid or lacks necessary rights.

Discussion