For Developers

Texts Overview

A Text is a type of Attachment that represents a body of plain or rich text. Text attachments can be associated with Assignments, Announcements, or Pages.

Text attachments are always part of an attachments object within a larger entity (like an assignment or page). There are no direct endpoints to list all text attachments from a class or other entity independently.

Properties

PropertyTypeDescription
typeAttachmentTypeThe type of the attachment, always text.
textstringThe actual text content. This may include HTML formatting if supported by the source system.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2023-01-01T12:00:00.000Z",
    "updated_date": "2023-01-01T12:00:00.000Z",
    "type": "text",
    "text": "This is a sample text attachment. It can contain plain text or <b>HTML content</b>."
}