links

Disable a public link

Switches the link off. It stops accepting new signers and linkUrl stops working.

This cannot be undone. There is no endpoint to switch a link back on — create a new one, or duplicate this one, if you need it live again.

This is also the required first step before DELETE /links/{linkId}, which refuses a link that is still live.

What it does and does not affect

  • Documents the link has already produced are untouched and stay accessible.
  • Someone who was part-way through signing when you disabled it is cut off immediately.
  • Someone who had already finished keeps their completed document and receipt.

On the credits pricing model this releases the billed link instance, with no refund for the current period.

Access

Not owner-only: anyone on the account may disable a link shared with the account. The read-level capability is enough, so an account whose subscription has lapsed can still switch its live links off.

put/links/{linkId}/disable

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/links/{linkId}/disable
  • 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.

Query parameters

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

Language for the error message

Response

Public link disabled 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.