---
title: "Enable, configure or disable the public link"
method: PUT
path: "/boards/{boardId}/public-link"
tags: ["Members"]
---

# Enable, configure or disable the public link

`PUT /boards/{boardId}/public-link`

## Request

- Base URL: `https://api.mockflow.com/v1`
- URL: `https://api.mockflow.com/v1/boards/{boardId}/public-link`
- Auth: HTTP bearer

Admin and above. The slug must be unique across every board's slug and id.

## Request body

- object
  - `enabled` boolean
  - `slug` string, nullable: Custom slug for the public URL. Null clears it.
  - `password` string: Set to protect. Send empty string to clear.

## Response `200`

OK

- PublicLink
  - `enabled` boolean
  - `url` string, uri, nullable: The /iview/ link, using the slug when one is set.
  - `slug` string, nullable
  - `passwordProtected` boolean
  - `embedUrl` string, uri, nullable
  - `embedHtml` string, nullable: A responsive iframe snippet for the public board.

## Other responses

- `429`: Too many requests.
- `4XX`: An error. See the envelope and the code list on the Errors page.

---

[API](https://skmtc.dev/mockflow/apis/mockflow-boards-api.md) - [All operations](https://skmtc.dev/mockflow/apis/mockflow-boards-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mockflow/apis/mockflow-boards-api/revisions/1a890390518c?raw)