documents->delete

documents->delete(string $id): void

Soft-delete a stored document. The PDF is purged from storage; metadata is retained for audit. Idempotent: the API answers 204 for an already-deleted document too, so a re-delete resolves.

Parameters

Name	Type	Required	Description
$id	string	required	(no description)

Returns

void

Errors

Code	When
MISSING_API_KEY	See [errors](../../../production/errors/) for the full description.
INVALID_API_KEY	See [errors](../../../production/errors/) for the full description.
ORGANIZATION_PURGED	See [errors](../../../production/errors/) for the full description.
ORGANIZATION_PAYMENT_GRACE	See [errors](../../../production/errors/) for the full description.
ORGANIZATION_CANCELLED	See [errors](../../../production/errors/) for the full description.
ORGANIZATION_MIGRATING	See [errors](../../../production/errors/) for the full description.
DOCUMENT_NOT_FOUND	See [errors](../../../production/errors/) for the full description.
FORBIDDEN	See [errors](../../../production/errors/) for the full description.
ENVIRONMENT_PROTECTED	See [errors](../../../production/errors/) for the full description.
STORAGE_ACCESS_DENIED	See [errors](../../../production/errors/) for the full description.
INTERNAL_ERROR	See [errors](../../../production/errors/) for the full description.
unknown_error	See [errors](../../../production/errors/) for the full description.
timeout	See [errors](../../../production/errors/) for the full description.
network_error	See [errors](../../../production/errors/) for the full description.

Example

<?php

declare(strict_types=1);

require __DIR__ . '/../vendor/autoload.php';

use PoliPage\PoliPage;

$client = PoliPage::client($_ENV['POLI_PAGE_API_KEY']);

$documentId = $argv[1] ?? throw new RuntimeException('usage: documents-delete.php <documentId>');

$client->documents->delete($documentId);

echo "deleted {$documentId}\n";

See also

• Errors
• Configuration