Update annotation

PATCH/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/{annotKey}v3.0.0-next.9

Update one annotation by key.

Authentication#

Any one of these credentials is accepted.

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Document token

Doc-scoped JWT, valid only on the /v1/docs/{docId} subtree it names, gated by the capability scopes it carries (each operation's x-required-capability).

Document capabilitydoc.annotate.modify

Parameters#

docIdpathstringrequired

layerNamepathstringrequired

ponpathintegerrequired

annotKeypathstringrequired

X-Document-Passwordheaderstring

Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

Request body#

application/jsonDocAnnotationsUpdateRequestrequired

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.doc.annotations.update({
  docId: "docId",
  layerName: "layerName",
  pon: 1,
  annotKey: "annotKey",
  body: {
    "key": "value"
  }
});

Responses#

200OK

application/jsonDocAnnotationsUpdate200Response

metaobject

affectedPagesobject[]

pageObjectNumberinteger

revisionobject

docSessionIdstring

pageObjectNumberinteger

generationinteger

weakAnnotationState"unknown" | "known"

kind =

kind"unknown"

cacheDeltaobject

previousDocVersioninteger

docVersioninteger

pagesobject[]

pageObjectNumberinteger

cacheobject

400Bad request

application/jsonDocAnnotationsUpdate400Response

name"EngineError"

messagestring

detailsobjectoptional

404Not found

application/jsonDocAnnotationsUpdate404Response

name"EngineError"

messagestring

detailsobjectoptional

defaultError

application/jsonEngineErrorPayload

name"EngineError"

messagestring

detailsobjectoptional