---
title: "A link to hand out: an optional password and expiry, and (review links) comments from viewers"
method: POST
path: "/builder/sessions/{sessionId}/share-links"
tags: ["Builder"]
---

# A link to hand out: an optional password and expiry, and (review links) comments from viewers

`POST /builder/sessions/{sessionId}/share-links`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/builder/sessions/{sessionId}/share-links`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `sessionId` string, uuid, required

## Request body

- object
  - `kind` 'preview' | 'review' | 'remix', required
  - `label` string
  - `password` string
  - `expiresInHours` integer, nullable: null or omitted: never expires
  - `allowComments` boolean: review links: viewers may comment

## Response `201`

The link

- object
  - `id` string, uuid, required
  - `kind` 'preview' | 'review' | 'remix', required
  - `label` string, nullable, required
  - `url` string, required: The link to hand out
  - `hasPassword` boolean, required
  - `expiresAt` string, nullable, required: ISO-8601 timestamp
  - `allowComments` boolean, required
  - `status` 'active' | 'expired' | 'revoked', required
  - `createdAt` string, required: ISO-8601 timestamp
  - `lastOpenedAt` string, nullable, required: ISO-8601 timestamp
  - `opens` integer, required

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `402`: Code editing and GitHub sync need a paid plan (code upgrade_required, details.feature builder.github_export), or a limit was reached
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: A change is running, the editor is stale (details.reason stale), a secret is in the code (secret_detected), or the draft is closed
- `501`: Not available on this server (code not_configured)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)