Sign in

v1

latestOpenAPI 3.1.02026-07-226875162.5 KB
Note Share Link

Upsert Share Link

Create or update a share link for a note.

  • If no link exists, creates a new one. If it already exists, updates password settings.
  • An empty body {} creates a link without a password.

usePassword behavior

usePasswordNo existing linkExisting link
null (omit)Create without passwordKeep current state
trueCreate with password(Re)generate password
falseCreate without passwordRemove password

sharePassword is only included when usePassword: true. Store it immediately — it cannot be retrieved later.

put/v1/external/notes/{noteGuid}/share-link

Path parameters

noteGuidstring required

Note GUID

Request body

usePasswordboolean nullable

Controls the share link password.

  • true — Generate password (regenerate if one exists)
  • false — Remove password (or create without one)
  • null / omitted — Keep current password state

Response

Share link created or updated

shareIdstring required

Unique share link identifier

shareUrlstring uri required

Full URL for accessing the shared note

sharePasswordstring nullable

Share link password.

  • Only returned on PUT with usePassword: true
  • Always null in GET responses
hasPasswordboolean required

Whether the share link has a password

Example response

{
  "shareId": "LHr1bHvCCdVCG",
  "shareUrl": "https://tiro.ooo/s/LHr1bHvCCdVCG",
  "sharePassword": "a1b2c3d4",
  "hasPassword": true
}