link

Change a link

Use this to change a link that keeps working: extend or remove its expiry, turn downloads on or off, limit it to emails or domains (which makes it verified), switch it to email or verified access (which makes a public link private) or set its protection. To stop a link for good, use link_revoke.

patch/links/{link_id}

Request

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

Path parameters

link_idstring required

link_create's id, or document_list's links_found.

Request body

downloadsboolean
allowstring[]

Who may open it: emails or whole domains, ["jane@fund.com", "northwind.vc"].

access'email' | 'verified'
protection'open' | 'protected' | 'locked'
mark_style'band' | 'tiled'

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.