Docs
Update Link
PATCH /documents/{documentId}/links/{linkId}
PATCH
/documents/{documentId}/links/{linkId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder. |
Updates a public access link. All fields are optional — only provided fields are applied.
Requires Admin access on the document (i.e. the EventDocumentsEdit permission or an Admin share).
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| documentId | Guid | Optional | The document that owns the link. |
| linkId | Guid | Optional | The link to update. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Optional | New human-readable label for the link. |
| isActive | bool | Optional | `false` to deactivate (public requests return 404); `true` to reactivate. |
| expiresAt | datetime | Optional | UTC expiry after which the link returns 404. Pass `null` to remove the expiry. |
| variableValues | string | Optional | JSON object mapping variable IDs to pre-set values. Merged into the viewer's request — viewer-supplied keys take precedence. Pass `null` to clear. |
| allowedValues | string | Optional | JSON object of arrays mapping variable IDs to whitelists. Viewer-submitted values outside the list are rejected with 400. Pass `null` to clear constraints. |
Response
200 OK with no body.