Skip to main content
PUT
/
v1
/
external
/
notes
/
{noteGuid}
/
share-link
curl --request PUT \ --url https://api.tiro.ooo/v1/external/notes/{noteGuid}/share-link \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "usePassword": true } '
{
  "shareId": "LHr1bHvCCdVCG",
  "shareUrl": "https://tiro.ooo/s/LHr1bHvCCdVCG",
  "sharePassword": "a1b2c3d4",
  "hasPassword": true
}

Authorizations

​
Authorization
string
header
required

API key in format {id}.{secret}

Path Parameters

​
noteGuid
string
required

Note GUID

Body

application/json
​
usePassword
boolean | null

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

​
shareId
string
required

Unique share link identifier

Example:

"LHr1bHvCCdVCG"

​
shareUrl
string<uri>
required

Full URL for accessing the shared note

Example:

"https://tiro.ooo/s/LHr1bHvCCdVCG"

​
hasPassword
boolean
required

Whether the share link has a password

Example:

true

​
sharePassword
string | null

Share link password.

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

"a1b2c3d4"