---
title: "Create Calendar Share Link"
method: POST
path: "/calendar_share_links"
tags: ["Calendar Share Links"]
---

# Create Calendar Share Link

`POST /calendar_share_links`

Create a new public calendar share link. `scope = entire` exposes every property in the operator's account; `scope = partial` exposes only the properties listed in `property_ids`. Each operator can have at most one entire-scope link: requesting one when it already exists simply returns the existing link.

## Request body

- object
  - `scope` 'entire' | 'partial', required — `entire` exposes every property of the operator; `partial` exposes only the ids listed in `property_ids`.
  - `property_ids` integer[] — Required (non-empty) when `scope = partial`. Each id must reference a property owned by the operator.

## Response `200`

- object
  - `request_id` string, required — Unique identifier for the request.
  - `error_code` integer, required — Numeric error code representing the status of the response. A value of `200` indicates success. <br> See the [Error Codes](/reference/error-manual#error-codes) section for more information.
  - `error_msg` string, required — Message detailing the status of the response.
  - `data` object, required
    - `calendar_share_link` CalendarShareLink, required
      - `id` integer, required — Internal share link id.
      - `scope` 'entire' | 'partial', required — `entire` covers every property of the operator; `partial` covers only the ids listed in `property_ids`.
      - `url` string, required — Public, read-only calendar URL. Anyone with this URL can view the calendar.
      - `property_ids` integer[], required — Property ids the link exposes. Empty array when `scope = entire`.
      - `created_at` string, date-time, nullable — ISO 8601 timestamp of when the share link was created.

---

[API](https://skmtc.net/hostex/apis/hostex-api.md) · [All operations](https://skmtc.net/hostex/apis/hostex-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hostex/hostex-api/revisions/a3fa555dee66/schema)