Soft-delete a document

delete

https://integrate.rooflink.com/roof_link_endpoints/api/light/documents/{id}/

Soft-deletes a document by marking it with a deletion timestamp. The document is not permanently removed from the database but will no longer appear in list or retrieve responses.

Only admin employees or employees with the can_delete_documents permission may delete documents. Regular employees will receive a 403 response.

Responses

204

Document successfully soft-deleted. No content is returned.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Unauthorized - The request cannot be authenticated. A valid API key must be provided via the X-API-KEY header.

403Forbidden - The authenticated user does not have permission to delete documents. Only admin employees or employees with the can_delete_documents permission may delete documents.

404Not found - The requested document does not exist or belongs to a different company.

429Too many requests - The client has exceeded the rate limits for this endpoint.

503Service unavailable - The total rate limits for the public APIs have been exceeded.