Annotations

Delete Annotations in a Layer.

This endpoint allows you to remove multiple annotations from the given layer.

The endpoint accepts one content type application/json. The request body is either a JSON array of annotations ids, or "all" in order to remove all annotations in one go.

delete/api/documents/{documentId}/layers/{layerName}/annotations

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/annotations
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Request body

Example request

{
  "annotationIds": "all"
}

Response

The annotations have been deleted from the layer.

Changes

No recorded changes to this operation across all 1 revision of this API.