link

Set or remove a link's passcode

Readers type the passcode after confirming their email, so the link becomes verified; five wrong tries lock an email out for 15 minutes. null removes it. It is stored hashed and never returned.

put/links/{link_id}/passcode

Request

  • Base URL: https://localhost:4410/api/v1
  • URL: https://localhost:4410/api/v1/links/{link_id}/passcode
  • Auth: HTTP bearer

Path parameters

link_idstring required

Request body

passcodestring nullable required

Response

The result.

idstring required
document_idstring nullable required
document_titlestring required
urlstring required
access'named' | 'email' | 'verified' | 'public' required
labelstring nullable required
recipient_emailstring nullable required
allowstring[] required
downloadsboolean required
detailed_analyticsboolean required
passcodeboolean required
noticestring nullable required
protection'open' | 'protected' | 'locked' required
mark_style'band' | 'tiled' required
round_idstring nullable required
public_blockedstring nullable required
expires_atstring date-time nullable required
state'active' | 'paused' | 'expired' | 'revoked' required
paused_reasonstring nullable required
viewsinteger required
last_viewed_atstring date-time nullable required
created_atstring date-time required

Changes

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