An External Link is a type of Attachment that represents a URL to an external resource. External Links can be associated with Assignments, Announcements, Pages, or Submissions.
External Links are always part of an attachments object within a larger entity (like an assignment or page). There are no direct endpoints to list all external links from a class or other entity independently.
Properties
| Property | Type | Description |
|---|---|---|
type | AttachmentType | The type of the attachment, always link. |
title | string | The title of the external link. |
description | string | A description of the external link. |
url | string | The URL of the external resource. |
thumbnail_url | string | A URL to a thumbnail image for the external link. |
JSON Example
{
"type": "link",
"title": "Edlink Documentation",
"description": "Comprehensive guides and API reference for Edlink.",
"url": "https://ed.link/docs",
"thumbnail_url": "https://ed.link/media/logo.png"
}