Variants

Update a link variant

Update the label and/or overrides, or revoke/un-revoke the variant. Omitted fields keep their current values; label: "" clears the label. An overrides object replaces the stored override set as a whole (see VariantUpdate) - include every override you want to keep. A revoked variant's link answers 404 to viewers (without revealing that a canonical link exists) until un-revoked. A redacted variant's label can never be set again (409).

put/api/v1/files/{uuid}/variants/{variantUuid}

Request

  • Base URL: https://everypage.co
  • URL: https://everypage.co/api/v1/files/{uuid}/variants/{variantUuid}
  • 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

New label; empty string clears it. Rejected (409) on a redacted variant.

revokedboolean

true revokes (viewers get 404), false un-revokes.

Response

The updated variant

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.