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

sessionIdstring uuid required

Request body

kind'preview' | 'review' | 'remix' required
labelstring
passwordstring
expiresInHoursinteger nullable

null or omitted: never expires

allowCommentsboolean

review links: viewers may comment

Response

The link

idstring uuid required
kind'preview' | 'review' | 'remix' required
labelstring nullable required
urlstring required

The link to hand out

hasPasswordboolean required
expiresAtstring nullable required

ISO-8601 timestamp

allowCommentsboolean required
status'active' | 'expired' | 'revoked' required
createdAtstring required

ISO-8601 timestamp

lastOpenedAtstring nullable required

ISO-8601 timestamp

opensinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.