---
title: "Disable a public link"
method: PUT
path: "/links/{linkId}/disable"
tags: ["links"]
---

# Disable a public link

`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`)

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.

## Path parameters

- `linkId` string, uuid, required

## Query parameters

- `errorLanguage` 'en' | 'sv' | 'es'

## Response `200`

Public link disabled successfully

- PublicLinkListDetail
  - `linkId` string, uuid: Unique identifier of the public link
  - `name` string: Name of the link
  - `createdAt` string, date-time: When the link was created
  - `updatedAt` string, date-time, nullable: When the link was last edited
  - `userId` string, 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.
  - `linkUrl` string, 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.

## Other responses

- `401`: Unauthorized - Missing or invalid access token.
- `403`: Forbidden - the link is private and belongs to another user, or the capability is missing.
- `404`: Public link not found
- `500`: Internal server error

---

[API](https://skmtc.dev/formify/apis/formify-api.md) · [All operations](https://skmtc.dev/formify/apis/formify-api/llms.txt) · [OpenAPI document](https://skmtc.dev/formify/apis/formify-api/revisions/571c4c0d4f4f?raw)