Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Calendar Share Links

Create Calendar Share Link

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.

post/calendar_share_links

Request body

scope'entire' | 'partial' required

entire exposes every property of the operator; partial exposes only the ids listed in property_ids.

property_idsinteger[]

Required (non-empty) when scope = partial. Each id must reference a property owned by the operator.

Response

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}