Share tokens

Mint a share link addressed to one recipient.

Set label to the person you are sending to: every open through this link is attributed back to that name and shows up in GET /sites/{idOrSlug}/recipients. To personalise ONE link across a whole mail-merge instead, skip this endpoint and append ?to={{contact.name}} to the page URL.

post/sites/{idOrSlug}/share-tokens

Request

  • Base URL: https://api.stacktr.ee
  • URL: https://api.stacktr.ee/sites/{idOrSlug}/share-tokens
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.stacktr.ee/oauth/authorize, token URL https://api.stacktr.ee/oauth/token, scopes: sites:write, sites:read)

Request body

labelstring

Who this link is for, e.g. "Megan Hanning". Becomes the attributed name on every open.

expires_in_hoursinteger

Token lifetime in hours. Omit for no token-level expiry.

max_usesinteger

Cap on uses. Omit for unlimited.

Response

Created.

idstring required
tokenstring required

Shown only in this response.

urlstring uri required

URL with ?t=<token> embedded; bypasses any password gate.

expires_atinteger nullable
max_usesinteger nullable
labelstring nullable
nextstring

On a labelled link only: what to tell the user about following up on it.

feedbackobject

Present when minting this named link also switched client comments on for the page.

Changes

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