Delete form widget

DELETE/v1/docs/{docId}/layers/{layerName}/form/widgets/{pageKey}/{annotKey}v3.0.0-next.15

Delete a widget: it leaves its page, and its field when it has one. The field survives, unplaced when this was its last widget. A widget that is its field's own dictionary is refused: delete the field. A widget is the form's, so the annotation routes refuse one.

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.forms.modify

Parameters#

docIdpathstringrequired

layerNamepathstringrequired

pageKeypathstringrequired

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.

Idempotency-Keyheaderstring

Names 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.

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.forms.deleteWidget({
  docId: "docId",
  layerName: "layerName",
  pageKey: "pageKey",
  annotKey: "annotKey"
});

Responses#

200OK

application/jsonDocFormsDeleteWidget200Response

widgetAnnotationRef

kind =

kind"objectNumber"

pagePageRef

kind"objectNumber"

objectNumberinteger

pagePageRef

kind"objectNumber"

objectNumberinteger

fieldFormField

metaFormMutationMeta

affectedPagesPageRef[]

kind"objectNumber"

objectNumberinteger

cacheDeltaCacheDelta

opIdstring

undoableboolean

changedFieldsFormFieldRef[]

kind =

kind"objectNumber"

objectNumberinteger

changedWidgetsFormWidget[]

refAnnotationRef

objectNumberinteger

pagePageRef

redrawnWidgetsFormWidget[]

refAnnotationRef

objectNumberinteger

pagePageRef

400Bad request

application/jsonDocFormsDeleteWidget400Response

404Not found

application/jsonDocFormsDeleteWidget404Response

defaultError

application/jsonEngineErrorPayload

name"EngineError"

messagestring

detailsobjectoptional