Blackboard

Retrieves a list of announcements for a specific course in the Blackboard learning management system. This endpoint allows users to access important messages, updates, or notifications related to a particular course. It should be used when there's a need to fetch all announcements or check for recent updates in a cour…

Untrusted display-only summary

Retrieves a specific announcement from a particular course in the Blackboard Learn system. This endpoint allows users to fetch detailed information about a single announcement, including its content, creation date, and any attachments. It is particularly useful for displaying announcement details in external applicati…

Untrusted display-only summary

This endpoint updates the relationship between a parent course and its child course in the Blackboard Learning Management System. It is used to modify existing course hierarchies, allowing administrators to restructure course organizations or adjust course relationships. The endpoint should be used when there's a need…

Untrusted display-only summary

This endpoint allows for the upload and attachment of files to a specific attempt within a course's gradebook in the Blackboard learning management system. It is used to associate submitted work, supporting documents, or any relevant files with a student's attempt on an assignment, quiz, or other assessable items. The…

Untrusted display-only summary

Initiates the OAuth 2.0 authorization code flow for the Blackboard API. This endpoint is used to obtain an authorization code, which is a crucial step in the OAuth 2.0 authentication process. The authorization code can later be exchanged for an access token, granting limited access to user resources on the Blackboard…

Untrusted display-only summary

Retrieves the gradebook information for a specific user within a particular course in Blackboard. This endpoint allows instructors or authorized personnel to access individual student grade data, including assignment scores, overall course grade, and any custom gradebook columns. It should be used when detailed grade…

Untrusted display-only summary

The CourseCopyTool allows you to create a copy of a Blackboard course with fine-grained control over which elements are included in the copy. This endpoint is used when you need to duplicate a course, either creating a new course or overwriting an existing one, while selectively choosing which components to transfer.…

Untrusted display-only summary

This endpoint creates a copy of an existing course in the Blackboard learning management system. It allows instructors or administrators to duplicate course content, settings, and structure into a new or existing course. Use this endpoint when you need to replicate a course for a new semester, create a template from a…

Untrusted display-only summary

Creates a new announcement within a specified course in the Blackboard learning management system. This endpoint allows instructors or course administrators to post important messages, updates, or notifications to all enrolled students. The announcement can be customized with a title, rich text body using BbML, and sp…

Untrusted display-only summary

Retrieves a list of courses from the Blackboard Learn platform. This endpoint allows developers to fetch information about courses available in the learning management system. It can be used to integrate course data into external applications, create custom dashboards, or sync course information with other systems. Th…

Untrusted display-only summary

Retrieves detailed information about a specific course in the Blackboard Learn platform using its unique identifier. This endpoint allows users to fetch comprehensive course data, which may include the course name, code, description, enrollment information, instructor details, and other relevant metadata. It's particu…

Untrusted display-only summary

Retrieves detailed information about a specific course in the Blackboard Learning Management System. This endpoint allows users to fetch comprehensive data related to a course, such as its title, description, start and end dates, enrollment information, and other course-specific attributes. It is particularly useful f…

Untrusted display-only summary

Creates a new group within a specified course in the Blackboard Learn system. This endpoint allows for detailed customization of group properties, including its name, description, availability, and enrollment settings. It's particularly useful for organizing students into smaller units for collaborative work, discussi…

Untrusted display-only summary

Updates the properties of a specific group within a Blackboard Learn course. This endpoint allows modification of group details such as name, description, availability, and enrollment settings. It's particularly useful for adjusting group configurations after initial creation, managing student access, and controlling…

Untrusted display-only summary

The PatchCourse endpoint allows for updating specific details and settings of an existing course in the Blackboard Learn system. It is used when modifications to course properties such as name, description, availability, enrollment options, or localization settings are needed. This endpoint supports partial updates, m…

Untrusted display-only summary

Updates an existing course in the Blackboard Learn system. This endpoint allows modification of various course attributes including basic information, availability settings, enrollment options, and localization preferences. It's used to adjust course details after initial creation, enabling instructors or administrato…

Untrusted display-only summary

Deletes a specific course from the Blackboard Learn platform. This endpoint should be used when an administrator or authorized user needs to permanently remove a course from the system, including all associated content, enrollments, and data. It is particularly useful for cleaning up old or unused courses, or when res…

Untrusted display-only summary

Creates a new course in the Blackboard Learn system with specified settings and configurations. This endpoint allows administrators or instructors to set up a course with various parameters including its basic information, availability, enrollment options, and localization settings. It's particularly useful when setti…

Untrusted display-only summary

Removes a specific user from a particular course in the Blackboard learning management system. This endpoint should be used when an administrator or instructor needs to unenroll a student, remove a teaching assistant, or disassociate any user from a course. It's particularly useful for managing course rosters, handlin…

Untrusted display-only summary

This endpoint updates a user-specific criterion within an adaptive release rule for a particular content item in a Blackboard course. It allows for fine-tuning of content visibility based on individual user conditions. Use this endpoint when you need to modify existing user-based criteria for adaptive release rules, s…

Untrusted display-only summary

This endpoint allows for the creation of new adaptive release criteria for a specific rule within a course's content in Blackboard. It is used to define conditions under which course content will be made available to students, such as completion of prerequisites, achievement of certain grades, or specific dates. The e…

Untrusted display-only summary

Creates a new system-wide announcement in the Blackboard Learn environment. This endpoint allows administrators to compose and configure announcements that can be displayed to users across the platform. The announcement can be customized with rich text content, specific visibility durations, and display locations such…

Untrusted display-only summary

Creates a new assignment within a specified Blackboard course. This endpoint allows instructors to set up detailed assignments with customizable settings for availability, grading, and plagiarism detection. It supports rich text instructions using BbML, adaptive release for controlled content visibility, and integrati…

Untrusted display-only summary

Adds a user to a specific meeting within a Blackboard course and sets their attendance status. This endpoint is essential for managing attendance and user participation in course meetings. It allows instructors or authorized users to update a student's attendance record for a particular meeting. The endpoint should be…

Untrusted display-only summary

This endpoint creates a new calendar item in the Blackboard platform. It allows users to add various types of events, such as course-related activities, personal appointments, or institution-wide events, to specific calendars within the system. The endpoint supports creating one-time events as well as recurring items…

Untrusted display-only summary

Creates a new category in the Blackboard catalog system. This endpoint allows administrators to define and organize content categories within the learning management system. Use this tool to add a new category with specific properties such as title, description, availability, and access restrictions. It's particularly…

Untrusted display-only summary

Creates a new content item within a specified course and parent content in the Blackboard Learn platform. This endpoint allows for the creation of various types of content, such as documents, external links, folders, and assignments. It provides extensive control over content properties, including title, body, descrip…

Untrusted display-only summary

Creates a new child node within the institutional hierarchy of Blackboard Learn. This endpoint allows administrators to expand and organize the structure of their educational institution by adding new nodes as children of existing ones. It is particularly useful for creating department, faculty, or program-level nodes…

Untrusted display-only summary

Creates a new attempt for a specific gradebook column in a Blackboard course. This endpoint allows instructors or authorized users to add a new attempt record for a student's assignment or assessment. It can be used to manually enter grades, provide feedback, or update the status of an attempt. The endpoint is particu…

Untrusted display-only summary

The CreateGroupAttempt endpoint allows for the creation or update of a group attempt for a specific gradebook column in a Blackboard Learn course. This tool is essential for managing group submissions, tracking their progress, and facilitating the grading process. It supports various aspects of group work, including s…

Untrusted display-only summary