RErebrandly
Links

Set Link OpenGraph

Set custom OpenGraph metadata for a link to control social media previews.

Requires:

  • Feature: links.opengraph

Blocked by:

  • Link deleted (status=3)
  • Revoked workspace
  • Revoked domain

Workspace Type: Classic or Gallery workspaces only.

post/links/{link_id}/opengraph

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/links/{link_id}/opengraph
  • Auth
    API key in header apikey

Path parameters

link_idstring required

Link public ID

Headers

Workspacestring
Example:workspace123abc

Workspace public ID

apikeystring required

API key for authentication

Request body

titlestring

OpenGraph title

descriptionstring

OpenGraph description

imagestring uri

OpenGraph image URL

Response

OpenGraph metadata set

titlestring

OpenGraph title

descriptionstring

OpenGraph description

imagestring uri

OpenGraph image URL

imageWidthinteger

Image width in pixels

imageHeightinteger

Image height in pixels

createdAtstring date-time
updatedAtstring date-time

Changes

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