Update annotation
Update one annotation by key.
Authentication#
Any one of these credentials is accepted.
The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.
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).
Parameters#
docIdpathstringrequiredlayerNamepathstringrequiredpageKeypathstringrequiredannotKeypathstringrequiredX-Document-PasswordheaderstringBase64-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.
Idempotency-KeyheaderstringNames the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
Request body#
application/jsonDocAnnotationsUpdateRequestrequiredSDK 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",
pageKey: "pageKey",
annotKey: "annotKey",
body: {
"key": "value"
}
});Responses#
application/jsonDocAnnotationsUpdate200ResponseannotationAnnotationsubtype"highlight"refAnnotationRefkind"objectNumber"pagePageRefkind"objectNumber"objectNumberintegerobjectNumberintegerpagePageRefkind"objectNumber"objectNumberintegerhasAppearancebooleanappearanceStatestringnmstringrectobjectxnumberynumberwidthnumberheightnumbercontentsstringsubjectstringblendMode"normal" | "multiply" | "screen" | "overlay" | "darken" | "lighten" | "color-dodge" | "color-burn" | "hard-light" | "soft-light" | "difference" | "exclusion" | "hue" | "saturation" | "color" | "luminosity"invisiblebooleanhiddenbooleanprintbooleannoZoombooleannoRotatebooleannoViewbooleanreadOnlybooleanlockedbooleantoggleNoViewbooleanlockedContentsbooleanreplyobjecttoAnnotationRefkind"objectNumber"pagePageRefobjectNumberintegertype"reply" | "group"popupAnnotationRefgroupIdstringauthorstringcreatedAtstring<date-time>modifiedAtstring<date-time>userIdstringcreatedBystringmodifiedBystringimportedBystringactionsPdfAnnotationActionscolorstringopacitynumberquadPointsobject[]upperLeftobjectxnumberynumberupperRightobjectxnumberynumberlowerLeftobjectxnumberynumberlowerRightobjectxnumberynumberappearanceobjectaction"preserved" | "regenerated" | "generation-unavailable" | "restored"changedbooleanmetaAnnotationMutationMetaaffectedPagesPageRef[]kind"objectNumber"objectNumberintegercacheDeltaCacheDeltaopIdstringundoablebooleanchangedAnnotationRef[]kind"objectNumber"pagePageRefkind"objectNumber"objectNumberintegerobjectNumberintegerapplication/jsonDocAnnotationsUpdate400Responseapplication/jsonDocAnnotationsUpdate404Responseapplication/jsonEngineErrorPayloadname"EngineError"code"Unknown" | "InvalidArg" | "DocNotOpen" | "DocOpenFailed" | "DocPasswordRequired" | "DocPasswordIncorrect" | "SharePasswordRequired" | "Aborted" | "Network" | "Unauthenticated" | "Forbidden" | "NotFound" | "WireFormat" | "RuntimeUnavailable" | "LayerVersionConflict" | "NotImplemented" | "MalformedPdf" | "SigningPending" | "SigningExpired" | "SigningVersionMismatch" | "SignatureRefused" | "ProtectedDocument" | "StaleBase" | "PayloadTooLarge" | "ObjectNumberUnavailable" | "LayerFull" | "ChangeConflict" | "UndoUnavailable" | "IdempotencyKeyReused"messagestringdetailsobjectoptional