Docs

Update Link

PATCH /documents/{documentId}/links/{linkId}

PATCH/documents/{documentId}/links/{linkId}

Updates a public link; only the fields provided are applied. Can rename it, deactivate or reactivate it (inactive or expired links return 404 to viewers), set or clear the expiry, pre-set variable values (viewer values win), and set allowed-value whitelists (other values are rejected with 400). Requires Admin access on the document.

Path Parameters

FieldTypeRequiredDescription
documentIduuidRequired
linkIduuidRequired

Request Body

FieldTypeRequiredDescription
namestringOptional
isActivebooleanOptional
expiresAtdate-timeOptional
variableValuesstringOptional
allowedValuesstringOptional