links

Update a public link

Replaces the link's configuration. The document is rebuilt from scratch with the slots you send, so send the whole configuration — anything omitted is lost, except fileId, which keeps the current document when omitted.

The public URL survives

linkUrl is unchanged by an edit. Anyone already holding the link keeps a working link.

Billing

An edit is not billed again — the existing link instance is carried over to the rebuilt link.

When editing is refused

Two states answer 409:

  • Disabled. Disabling is permanent, so there is nothing left to edit. Duplicate the link instead — POST /links/{linkId}/duplicate gives you the same configuration as a new, billed link.
  • Still processing. A link created or edited with the AI assistant enabled reports status: "processing" while the assistant reads the document, and cannot be edited until that finishes. Poll GET /links/{linkId} until it reports active, then edit.

Access

Owner only. A colleague can read and disable a shared link but not edit it.

put/links/{linkId}

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/links/{linkId}
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token, scopes: write)

Path parameters

linkIdstring uuid required

The unique identifier of the public link.

Request body

fileIdstring uuid

File ID from POST /files. Omit to keep the link's current document.

namestring

Name of the link. Omit to keep the current name.

sharingSetting'private' | 'shared'

See CreatePublicLinkRequest.sharingSetting.

language'en' | 'sv' | 'es'

Language of the signing experience

disablePrintingboolean

Prevent signers from printing the document.

errorLanguage'en' | 'sv' | 'es'

Language for error messages

Example request

{
  "signeeDetails": [
    {
      "fullName": "Buyer",
      "signatureType": "digital_ink",
      "signaturePlacement": "existing",
      "signatureBox": {
        "page": 0,
        "x": 72,
        "y": 560,
        "scale": 1
      },
      "requireNameClarification": true
    }
  ],
  "aiAssistant": {
    "enabled": true,
    "textToSpeech": false,
    "language": "en"
  }
}

Response

Public link updated successfully

linkIdstring uuid

Unique identifier of the public link

namestring

Name of the link

createdAtstring date-time

When the link was created

updatedAtstring date-time nullable

When the link was last edited

userIdstring uuid

User ID of the link owner

sharingSetting'shared' | 'private'

Who on the account may administer the link

status'active' | 'disabled' | 'processing'
  • active: the link is live and can be opened and signed.
  • disabled: the link has been switched off and no longer accepts new signers. Documents already produced by it are unaffected. There is no way to switch it back on.
  • processing: the AI assistant is still reading the document. linkUrl is null and the link cannot be edited until this finishes.

Note this is a different set of values from a document's status — a link is a source of documents rather than a signature request, so it has no signing progress of its own.

linkUrlstring nullable

The link to share. null while status is processing, because the document is not servable yet.

Uses the account's custom domain when one is configured. Formify never sends this to anyone — distributing it is up to you.

Changes

No recorded changes to this operation across all 1 revision of this API.