Hyperlink Data Model

Link between content and a page, asset, external URL, or email address.

Hyperlink records are created by the Live Editor system when content blocks are created or modified to contain links.

Sample JSON Data

      {
        "data": {
          "id" "c9017f08-5433-47f2-85d4-2c9ca66a5ec4",
          "type": "hyperlinks",
          "attributes": {
            "created-at": "2012-04-23T18:25:43.511Z"
          },
          "relationships": {
            "linkable": {
              "data": {
                "type": "content-blocks",
                "id": "a4cb4610-8c2f-4979-a292-7e918fe9c2be"
              }
            },
            "linked-to": {
              "data": {
                "type": "pages",
                "id": "d0b811bf-7311-47cb-97a3-2f52dc975eaa"
              }
            }
          }
        }
      }

Attributes

Attribute Type Required Description
created-at date Read-only Records when hyperlink record was created, localized to the current logged in user’s time zone.

Relationships

Title Type Required Description
linkable object Read-only Content being linked from. This will be a content block or a draft of a content block item. (Each is tracked separately.)
linked-to object Read-only Content being linked to. This will be a page, asset, external URL, or email address.

Related