Metadata

Set a link's preview

Send null for a field to clear the override and fall back to the destination page's own tag.

patch/links/{id}/metadata

Request

  • Base URL: https://fixed.link/api/v1
  • URL: https://fixed.link/api/v1/links/{id}/metadata
  • Auth: HTTP bearer

Path parameters

idstring required

Link ID

Request body

previewMode'auto' | 'custom' | 'off'

"auto" unfurls with the destination's tags, "custom" with yours, "off" disables the preview page.

titlestring nullable
descriptionstring nullable
imageUrlstring uri nullable

Absolute http(s) URL.

siteNamestring nullable

Response

The updated metadata

status'pending' | 'fetching' | 'ok' | 'failed' | 'skipped' required

State of the background fetch of the destination page.

previewMode'auto' | 'custom' | 'off' required
resolvedUrlstring nullable required
httpStatusinteger nullable required
errorstring nullable required
fetchedAtstring date-time nullable required

Changes

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