Variants

Create a link variant

Mint a per-recipient child link for a file you own (Pro, files:write). The variant has its own 12-char short id and URL, an optional label (recipient name, GDPR-redactable) and overrides (allowDownload, pageRange). Views through it are attributed in readership and in file.opened/file.viewed/file.downloaded webhook payloads (variantUuid/variantLabel). Up to 200 variants per file.

Passwords and viewing gates are deliberately per-FILE, not per-variant: a viewer who passed the file's gate through one link has passed it for all of the file's links.

post/api/v1/files/{uuid}/variants

Request

  • Base URL: https://everypage.co
  • URL: https://everypage.co/api/v1/files/{uuid}/variants
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://everypage.co/oauth/authorize, token URL https://everypage.co/oauth/token, scopes: files:write)

Request body

labelstring

Optional recipient tag (shown in readership and webhook payloads; erasable via redaction).

Response

Created

uuidstring uuid
shortIdstring

The variant's own share-URL alias.

urlstring

The full shareable link (the owner's custom domain when one is verified).

labelstring

Recipient tag. Absent when never set - and, permanently, after redaction.

revokedboolean

A revoked variant's link answers 404 to viewers until un-revoked.

redactedAtstring date-time

Present after GDPR redaction (the label is gone for good).

createdAtstring date-time

Example response

{
  "shortId": "aB3xY9kQ2mZ7",
  "url": "https://everypage.co/aB3xY9kQ2mZ7",
  "label": "Jane at Acme"
}

Changes

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