Blackboard connector

What your chats can do

314 tools from Blackboard.

Course Announcements AccessRetrieves 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 course. The tool returns announcement data but does not provide functionality for creating, updating, or deleting announcements. Keep in mind that the returned list may be paginated if there are many announcements, and additional calls might be necessary to retrieve all data.
Get course announcement by idRetrieves 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 applications or for retrieving updated information about a previously known announcement. The endpoint requires both the course ID and the announcement ID to ensure precise retrieval of the intended announcement. It should be used when specific announcement details are needed, rather than for listing all announcements in a course.
Update child course in parentThis 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 to change the parent-child association between two courses, such as moving a sub-course to a different parent course or updating the hierarchical structure of courses. It's important to note that this endpoint only modifies existing relationships and does not create new courses or new child-parent associations if they don't already exist in some form.
Upload file to attempt in gradebookThis 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 endpoint should be called after the initial file upload process, using the generated uploadId to link the file to the specific attempt. It's particularly useful for instructors or system integrators who need to programmatically attach files to student submissions, or for building custom submission interfaces that interact with Blackboard's backend. This endpoint does not handle the actual file transfer; it assumes the file has already been uploaded to Blackboard's system and is now being associated with a specific attempt.
Get oauth2 authorization codeInitiates 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 platform. This endpoint should be called when an application needs to request permission from a user to access their Blackboard data. It's important to note that this endpoint does not directly provide access to user data; it only initiates the authorization process. The response will typically include a redirect URL containing the authorization code, which the client application must handle appropriately.
Get user gradebook for courseRetrieves a page of gradebook entries for a specific user in a Blackboard course, including scores and other grade-related data. The legacy status field is unreliable; determine grading state from the manual grade and any associated attempts instead.
Copy course with specific optionsThe 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. It's particularly useful for course administrators or instructors preparing for a new semester or creating variations of an existing course. The tool provides extensive customization options, allowing you to include or exclude specific course elements such as content areas, assessments, gradebook settings, and more. However, it does not handle enrollment of students or instructors in the new course - this must be done separately after the copy is complete.
Copy course by courseidRequests a copy of an existing Blackboard course into a target course, for example to reuse course content in another course. The copy is asynchronous. DEPRECATED: This uses a legacy course-copy operation.
Create course announcementCreates 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 specific availability settings. Use this endpoint when you need to communicate course-wide information, such as syllabus changes, assignment reminders, or important dates. The announcement can be created as a draft for later publication or immediately made visible based on the specified availability settings.
Retrieve course listRetrieves a paginated list of Blackboard courses and organizations, with optional search filters and sorting.
Course endpoint entitlement accessRetrieves 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 particularly useful for applications that need to display or process course information, such as student portals, administrative tools, or integration with other educational systems. The endpoint should be used when specific course details are required, but it will not provide information about student performance or course content. Note that the exact scope of information returned may depend on the user's permissions within the Blackboard system. name = "course_endpoint_entitlement_access" display_name = "Course Endpoint Entitlement Access"
Retrieve course details by idRetrieves 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 for applications that need to display or process course information outside of the Blackboard interface. This tool should be used when detailed course information is required for a known course ID, but it will not provide a list of all courses or modify any course data.
Create course groupCreates 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, discussions, or specific course activities. The function supports creating both regular groups and group sets, with options for self-enrollment or instructor-managed membership. Use this when setting up course structures that require student groupings, whether for project teams, study groups, or other collaborative activities within a course.
Update group details by course and group idUpdates 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 enrollment options. The endpoint supports partial updates, allowing you to modify only the specified fields without affecting others. Use this when you need to change group settings, update availability, or adjust enrollment limits and signup options for an existing group in a course.
Update course information by courseidThe 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, meaning only the fields that require changes need to be included in the request body. It's particularly useful for making adjustments to course settings after initial creation or for updating course information based on changes in the academic calendar or institutional policies. However, it's important to note that some settings, like allowing guests or observers, are only modifiable for Classic courses, and certain operations may be restricted when a course is in a closed and complete state.
Update course informationUpdates 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 administrators to manage course lifecycle and accessibility. The endpoint requires the course ID and accepts a range of optional parameters for fine-tuning course properties. It's particularly useful for making bulk changes to course settings or adapting courses to changing educational needs. Note that some settings, like allowing guests, are only modifiable for specific course types (Classic vs Ultra).
Delete course by courseidDeletes a specified Blackboard Learn course or organization. The removeFiles option controls whether course files are deleted and defaults to true.
Create a class courseCreates a Blackboard Learn course or organization with a course ID and name. Optional settings include availability, enrollment, localization and Ultra status.
Delete user from courseRemoves 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, handling student withdrawals, or updating staff assignments. The operation is irreversible, so it should be used with caution. This endpoint does not delete the user from the entire Blackboard system; it only removes their association with the specified course. It's important to note that this action may affect the user's access to course materials and their course-related data.
Update user criterion in adaptive ruleAdds or updates a user association for a specific adaptive release criterion on a Blackboard course content item.
Create adaptive release criteria by ruleRequests creation of an adaptive release criterion for an existing rule on a Blackboard course content item. The tool does not accept criterion settings as input.
Create system announcementCreates 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 as the login page or within courses. Use this endpoint when you need to broadcast important information, updates, or alerts to all users or specific segments of your Blackboard Learn community. It's particularly useful for system-wide notifications, maintenance alerts, or important institutional announcements. Note that creating excessive or irrelevant announcements may lead to information overload for users, so use this feature judiciously.
Create assignment in course contentsCreates 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 integration with originality reporting tools. Use this endpoint when you need to programmatically create assignments with specific requirements or to batch create multiple assignments. The endpoint provides extensive customization options but requires careful consideration of parameters to ensure the assignment is set up correctly for student access and evaluation.
Update user meeting attendance statusAdds 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 used when recording attendance for course meetings, updating a user's attendance status, or integrating external attendance tracking systems with Blackboard. It provides a way to maintain accurate attendance records, which can be crucial for course management and student engagement tracking.
Create calendar itemsThis 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 with customizable recurrence patterns. It also facilitates the integration of Learning Tools Interoperability (LTI) links, enabling the association of external learning tools with calendar items. This endpoint should be used when adding new events or activities to Blackboard calendars, but it cannot be used to modify existing calendar items or to create items for the read-only GradebookColumn type.
Add catalog category by typeCreates 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 useful for structuring course offerings, organizing resources, or creating custom catalogs within Blackboard. The created category can be set to appear on the front page and can be restricted to specific institutional roles, providing flexible control over content organization and access.
Create child content in courseCreates 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, description, availability, and positioning within the course structure. The endpoint supports rich text formatting through BbML and offers features like review status and adaptive release settings. It should be used when adding new materials, resources, or organizational elements to a course. Note that the content type is determined by the contentHandler, and some properties may have different effects depending on the course experience (Classic vs. Ultra).
Add child node in hierarchyCreates a child node under a specified node in the Blackboard Learn institutional hierarchy. The parent node ID and new node title are required; an external ID, description, and parent ID can also be supplied.
Submit gradebook attemptCreates an attempt for a gradebook column in a Blackboard course, with optional status, score, notes and feedback. The user defaults to the authenticated user; submitting for another user requires the applicable user and application entitlements.
Post group attempts for gradebook columnThe 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 submission status tracking, grading, feedback, and metadata management. The endpoint is particularly useful for instructors and course administrators who need to manage group assignments and assessments within the Blackboard learning environment. It provides flexibility in handling different stages of the submission process, from initial attempt to final grading, and supports both regular and Ultra course formats. However, users should be aware that some status options are deprecated and may cause unexpected behavior if used.
Create course content in courseCreates new content within a specified Blackboard course. This endpoint allows for the addition of various types of content, including documents, external links, folders, and more, with detailed configuration options. It supports rich text formatting through BbML, hierarchical content structure, and granular control over content availability and accessibility. Use this endpoint when adding new materials, resources, or structural elements to a course. It's particularly useful for bulk content creation or programmatic course setup. Note that while it offers extensive customization, some advanced features may depend on the Blackboard Learn version in use.
Update content group associationThis endpoint updates the association between a specific content item and a group within a Blackboard Learn course. It is used to modify existing content-group relationships, enabling instructors or administrators to manage group-specific content access or visibility. The endpoint requires the course ID, content ID, and group ID to be specified in the URL path, with the content ID and group ID repeated in the request body for confirmation. This operation is particularly useful for customizing content delivery to different student groups or managing group-based learning activities within a course. Note that this endpoint only updates existing associations and cannot create new content or groups.
Create a new courseCreates a new course in the Blackboard Learn system with specified attributes and settings. This endpoint allows for the detailed configuration of a course, including its basic information, availability, enrollment options, and localization settings. It supports both Classic and Ultra course views and provides flexibility in defining course duration, access control, and integration with external systems. Use this endpoint when setting up a new course or organization within Blackboard, ensuring all required parameters are provided and optional parameters are used as needed to fully customize the course setup.
Create course meetingCreates a new meeting for a specific course within the Blackboard learning management system. This endpoint allows you to schedule and define the details of a course meeting, including its title, description, start and end times, and an optional external link. Use this when you need to add a new meeting or event to a course's calendar or schedule. The created meeting will be associated with the specified course and visible to course participants. This tool is specifically for creating new meetings and cannot be used to update existing ones or retrieve meeting information.
Create data source with external idCreates a new data source in the Blackboard Learn system. This endpoint is used to establish a unique identifier for an external data source, which can then be referenced in other API calls or integrations. It's particularly useful when setting up integrations between Blackboard and external systems, such as Student Information Systems (SIS) or other educational tools. The created data source can be used for various purposes, including batch operations, data synchronization, or as a reference point for imported content. This endpoint should be used when initially setting up a new integration or when a new external system needs to be recognized within Blackboard. It's important to note that the externalId must be unique across all data sources in the Blackboard instance, and once created, it cannot be changed.
Create discussion forum in courseCreates a new discussion forum within a specified course in the Blackboard Learning Management System. This endpoint allows instructors or course administrators to set up a discussion topic, define its availability, and optionally make it gradable. It's particularly useful for initiating course-related discussions, Q&A sessions, or collaborative learning activities. The endpoint requires a course ID in the path and accepts JSON payload with discussion details. It should be used when setting up new discussion areas for a course, but not for posting individual messages within an existing discussion. Note that while you can set the initial topic message, many properties of the discussion are auto-generated and read-only.
Create lti domain configurationCreates or updates an LTI (Learning Tools Interoperability) domain configuration in Blackboard Learn. This endpoint allows administrators to set up and manage integrations with external learning tools, configuring various aspects such as user data sharing, security settings, and service permissions. It's used when setting up a new LTI tool or modifying an existing integration to control how the tool interacts with Blackboard and what data it can access. The configuration includes options for managing user privacy, tool authentication, and access to Blackboard services like membership and grading.
Add course content attachmentRequests creation of an attachment for a specified Blackboard course content item. The tool does not accept file content for upload.
Add new gradebook column for courseCreates a new grade column in a course's gradebook within the Blackboard Learn platform. This endpoint allows instructors or administrators to set up various types of grade columns, including manual entry, calculated grades, and those based on student attempts. It supports features such as anonymous grading, external tool integration, and custom formulas for grade calculation. The endpoint is particularly useful when setting up a new assignment or assessment that requires a corresponding grade column in the course gradebook. It should be used to establish the grading structure for a course, but not for entering actual grades (which would be done through a separate endpoint). Note that some features may have version-specific availability, and certain settings (like includeInCalculations) may behave differently between Classic and Ultra courses.
Post grade notation to course gradebookCreates a new grade notation in the gradebook for a specific course in Blackboard. This endpoint allows instructors or administrators to add custom performance codes and their corresponding descriptions to the grading system. It's particularly useful for implementing non-standard grading schemes or providing additional context to traditional letter or number grades. The created grade notation can then be used when assigning grades to students, offering more nuanced feedback on their performance. This tool should be used when setting up or modifying the grading structure for a course, especially in cases where standard grading notations are insufficient to capture the full range of student performance or special grading circumstances.
Create course gradebook schemaCreates a new gradebook schema for a specific course in Blackboard Learn. This endpoint allows instructors or administrators to define custom grading structures tailored to their course needs. It supports various grading scales including percentage, score-based, tabular (letter grades), text-based, and complete/incomplete systems. The created schema can then be applied to assignments and other gradable items within the course. This tool is essential for setting up the grading framework at the beginning of a course or when implementing a new grading strategy. It should be used carefully as it forms the foundation for grade calculations and student grade representations throughout the course.
Create grading period in course gradebookCreates a new grading period within a specific course's gradebook in the Blackboard Learn system. This endpoint allows instructors or administrators to define and organize temporal segments for grade collection and management. It's particularly useful for structuring the academic year into distinct grading intervals, such as semesters, quarters, or specific assessment periods. The created grading period can be used to associate gradable items (columns) with specific timeframes, facilitating organized grade tracking and reporting. This endpoint should be used when setting up a new course structure or adjusting existing grading timelines. It's important to note that while the endpoint offers flexibility in date handling, careful consideration should be given to the dateMode parameter and its implications on start and end dates.
Create course group in courseCreates a new group within a specified course in the Blackboard learning management system. This endpoint allows instructors or administrators to set up and configure groups for collaborative work, discussions, or other course-related activities. The function provides extensive customization options for group availability, enrollment methods, and signup processes. It's particularly useful for organizing students into smaller teams for projects, facilitating peer-to-peer learning, or managing course sections. Note that while many parameters are optional, careful configuration is recommended to ensure the group serves its intended purpose within the course structure.
Update user in course groupCreates a user's membership in a specified Blackboard course group using the course, group and user identifiers.
Modify course content adaptive release group criteriaAssociates a group with a criterion in an adaptive release rule for a Blackboard course content item.
Create group setCreates a new group set within a specified course in the Blackboard Learn platform. This endpoint allows instructors or administrators to set up a structured group of students for collaborative work, discussions, or other course activities. The group set can be configured with various settings controlling its visibility, enrollment method, and description. Use this when you need to organize students into groups for project work, facilitate peer reviews, or create focused discussion spaces within a course. It's particularly useful for larger classes where multiple small groups are needed for effective collaboration and management.
Create group in courseCreates a new group within a specified course group set in the Blackboard Learn platform. This endpoint allows instructors or administrators to set up groups with customizable settings for student collaboration and activities. It provides options for controlling group availability, enrollment methods, and detailed descriptions using BbML formatting. Use this endpoint when you need to create structured student groups within a course, whether for project work, discussions, or other collaborative activities. The created group can be configured for instructor-managed enrollment or student self-enrollment, with optional signup sheets and member visibility settings.
Update course category detailsCreates or updates a course or organization membership in a Blackboard catalog category, identified by category type, category ID, and course ID.
Post course message with bbml supportCreates a new message within a specific Blackboard course. This endpoint allows users to compose and send messages to course participants, supporting rich text formatting through BbML, file attachments, and flexible recipient management. It's ideal for course announcements, discussions, or direct communication between instructors and students. The endpoint should be used when there's a need to initiate or continue a conversation within the context of a particular course. It provides comprehensive options for message creation, including subject, body content with rich formatting, recipient lists (To, CC, BCC), and file attachments. However, it does not support scheduling messages for future delivery or sending to recipients outside the course context.
Post discussion message replyCreates a reply to a specific message within a Blackboard course discussion. This endpoint allows users to contribute to ongoing discussions by posting responses to existing messages. It supports both course-wide and group-specific discussions, with options to control the visibility and state of the reply. The content of the reply must be formatted in BbML (Blackboard Markup Language) for rich text support. Use this endpoint when a user wants to respond to a particular message in a discussion thread, either immediately publishing the reply or saving it as a draft for later review.
Create institutional hierarchy nodeCreates a new node in the institutional hierarchy of Blackboard. This endpoint allows for the addition of organizational elements such as departments, courses, or other structural units within an educational institution's Blackboard system. It is used to build and maintain the hierarchical structure that organizes content and permissions. The endpoint requires a JSON payload with node details and supports optional parameters for flexibility in node creation and positioning within the hierarchy.
Update course primary node associationThis endpoint updates the association between a specific course and a node in the Blackboard institutional hierarchy. It allows you to set or change whether the specified node is the primary association for the given course. Use this endpoint when you need to modify the primary status of a course-node relationship, such as when restructuring your institution's course organization or correcting misallocations. The endpoint is particularly useful for managing courses that span multiple nodes or departments. Note that this operation only affects the 'primary' status of the association and does not create or delete associations between courses and nodes.
Update institutional hierarchy user nodeCreates an association between a user and a specified node in the Blackboard institutional hierarchy.
Update user observerCreates an observer relationship between a specified Blackboard user and observer.
Create new lti placementCreates a new LTI (Learning Tools Interoperability) placement in the Blackboard Learn system. This endpoint allows integration of external tools and services into the learning management system, enhancing the capabilities and user experience. It supports various types of placements, including content handlers, system tools, and course navigation elements. Use this endpoint when you need to add a new external tool or service to Blackboard Learn, specifying its type, location, and configuration settings. The created placement can be used for various purposes such as content delivery, student engagement, or administrative tasks, depending on the specified type.
Post pronouns detailsCreates a new pronoun entry in the Blackboard Learning Management System. This endpoint is used to add new pronouns to the system's user identity management, supporting inclusive and diverse user representation. It should be used when administrators or authorized users need to introduce new pronoun options for users to select from. The endpoint incorporates an approval workflow, allowing for review of new pronoun entries before they become available for general use. Note that this endpoint only creates the pronoun entry; it does not assign pronouns to specific users or modify existing user profiles.
Post course assessment questionThis endpoint creates a new question within an existing Blackboard assessment. It supports various question types and allows for customization of content, feedback, and scoring. Use it to build or modify assessments by adding new questions. Note that while many parameters are optional, the 'text' field is required. The question type determines its structure and behavior, but specific configurations may require additional documentation.
Create course rubric with detailsCreates a new rubric for a specific course in Blackboard Learn. This endpoint allows instructors or course designers to define a structured evaluation tool with customizable criteria, performance levels, and scoring methods. The rubric can be used for various assessment types, including assignments, discussions, and projects. It supports different rubric types (Numeric, Percentage, Range-based) to accommodate diverse grading needs. The created rubric can include detailed descriptions for each performance level and criterion, ensuring clear expectations and consistent grading across evaluators. This tool is essential for setting up comprehensive and transparent assessment frameworks within Blackboard courses.
Create rubric association in courseCreates a new association between a rubric and a specific course content item in the Blackboard learning management system. This endpoint allows instructors or course designers to link a rubric to elements such as assignments, discussions, or other gradable items within a course. It's used to establish grading criteria, set visibility options for students, and connect the rubric to the appropriate gradebook column or question. The association can be configured for grading purposes or as an informational guide, with flexible options for when and how students can view the rubric and its evaluation. This tool is essential for implementing consistent assessment strategies across course content and providing clear expectations to students.
Create rubric evaluation for courseCreates or updates a rubric evaluation for a specific course, rubric, and rubric association in the Blackboard Learn platform. This endpoint allows instructors or authorized users to submit detailed evaluations of student work using predefined rubrics. It supports various types of rubrics (Numeric, Numeric Range, Percentage, Percentage Range) and allows for granular scoring and feedback at the cell level. The evaluation can be associated with individual, group, or question attempts, providing flexibility for different assessment scenarios. Use this endpoint when you need to programmatically submit or modify rubric-based evaluations, such as grading assignments or providing structured feedback on assessments.
Add adaptive release rule to course contentCreates a new adaptive release rule for a specific content item within a Blackboard course. This endpoint allows instructors or course administrators to set up conditions for releasing course content to students based on various criteria. The rule is identified by a title and associated with a particular content item in a course. Use this when you need to control the visibility or accessibility of course materials based on specific conditions. Note that while this endpoint creates the rule, setting up the specific conditions for release would likely require additional API calls or configuration.
Create term with availability and descriptionCreates a new term in the Blackboard Learn system with the specified attributes. This endpoint allows administrators to define academic periods or sessions, setting up the structure for courses and student enrollments. It provides options for customizing term availability and duration, which is crucial for managing access to educational content over time. The created term can be associated with a specific data source, enabling integration with external systems. Use this endpoint when setting up a new academic year, semester, or any other defined study period in your institution's Blackboard environment.
Create new user profileCreates a new user account in the Blackboard Learn system with detailed profile information. This endpoint allows for the creation of user profiles with comprehensive data, including personal details, educational information, institutional and system roles, contact information, and localization preferences. It should be used when adding new users to the system, such as during student enrollment, faculty onboarding, or administrative staff addition. The endpoint requires at least the user's name, username, and password, but allows for extensive customization of the user profile with optional fields. It's important to note that some fields have specific formats or enumerated values that must be adhered to for successful user creation.
Delete user criterion from course content ruleRemoves a specific user from an adaptive release rule criterion for a particular content item within a course. This endpoint is used to modify the conditions under which course content is made available to individual students. It should be used when an instructor or administrator wants to exclude a user from a previously set adaptive release criterion. This action may be necessary when updating course accessibility or correcting mistakenly applied criteria. The endpoint does not provide information about the rule or criterion itself, nor does it return any data about the removed user. It's important to note that this operation is irreversible, and re-adding the user would require a separate API call.
Delete adaptive release rule criterionDeletes a specific criterion from an adaptive release rule for a content item within a Blackboard course. This endpoint allows instructors or course administrators to remove individual conditions that control when content becomes available to students. Use this when you need to modify an existing adaptive release rule by removing a particular criterion, such as a date restriction or grade requirement. The deletion is permanent and cannot be undone, so use with caution. This operation does not affect other criteria within the same rule or other rules applied to the content item.
Delete user course meetingsDeletes all meeting attendance records for a specific user within a particular course in the Blackboard system. This endpoint is used when an administrator or instructor needs to remove all attendance data for a student, which may be necessary for course transfers, data corrections, or privacy compliance. It should be used with caution as it permanently removes all attendance records for the specified user in the given course. This operation cannot be undone, so it's important to verify the necessity of this action before proceeding. The endpoint does not provide any information about the deleted records or return a list of affected meetings.
Delete course meetingDeletes all meetings associated with a specific course in the Blackboard Learn platform. This endpoint should be used when an instructor or administrator needs to remove virtual sessions or scheduled meetings from a course, potentially at the end of a term or when restructuring the course schedule. It's important to note that this operation may be irreversible and could affect all meetings linked to the specified course. Use with caution, as it might impact student access to past or upcoming virtual sessions. The endpoint does not provide options for selective deletion of individual meetings, so it should only be used when intending to remove all meetings from the course.
Delete all records in meetingDeletes all attendance records in the course meeting for a given meeting Id. The 'course.attendance.DELETE' entitlement is required to delete attendance records. **Since**: 3500.7.0
Delete announcement by idDeletes a specific announcement from the Blackboard Learning Management System (LMS) using its unique identifier. This endpoint should be used when an instructor, administrator, or authorized user needs to permanently remove an announcement from a course or the system. It's particularly useful for managing outdated information or correcting mistakenly posted announcements. The deletion is irreversible, so users should exercise caution when invoking this endpoint. This tool does not provide a way to archive or recover deleted announcements, nor does it return the content of the deleted announcement.
Delete gradebook attempt fileDeletes a specific file associated with an attempt in a course's gradebook within the Blackboard Learn environment. This endpoint should be used when an instructor or administrator needs to remove a file that was incorrectly uploaded or is no longer relevant to a student's attempt. It permanently removes the file from the system, so it should be used with caution. This operation cannot be undone, and the file cannot be recovered once deleted. The endpoint does not provide any information about the deleted file or confirm its previous existence.
Delete attendance recordDelete attendance record for meeting.It will delete meeting attendance within a course meeting. The 'course.attendance.DELETE' entitlement is required to delete Attendance Record. **Since**: 3500.7.0
Delete calendar item by type and idDeletes a Blackboard calendar item identified by type and ID, with an option to delete its recurring series instead of only the selected item.
Delete category by type and idThis endpoint deletes a specific category from the Blackboard catalog based on the provided category type and ID. It should be used when an administrator or authorized user needs to remove a category that is no longer needed or relevant. The operation is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful for catalog maintenance, such as removing outdated course categories or reorganizing the catalog structure. It does not return any content upon successful deletion, typically responding with a 204 No Content status. Be aware that deleting a category may affect related items or sub-categories, depending on the Blackboard system's configuration.
Delete course content by idDeletes a specified content item from a Blackboard course. Optionally, associated grade columns can be marked deleted and their attempts and grades removed; otherwise, attempts are retained and grades converted to manually entered grades.
Delete course content group by idThis endpoint deletes a specific group associated with a content item within a Blackboard course. It is used to remove group assignments or collaborations tied to particular course content. The operation is irreversible and should be used with caution, as it will permanently remove the group's association with the content item. This can affect student access and collaboration settings for the specified content. The endpoint should be used when reorganizing course structure, removing outdated group assignments, or cleaning up course content. It does not delete the content item itself or the course, only the group's association with the content. Note that this operation may impact students currently assigned to the group, potentially affecting their access to the content item.
Delete course by idDeletes a specified Blackboard course. Course files are deleted by default, with an option to retain them; use this destructive operation with caution.
Delete course meetingThis endpoint deletes a specific meeting within a course in the Blackboard learning management system. It should be used when an administrator or instructor needs to remove a scheduled meeting from a course, such as cancelling a virtual class session or removing an outdated meeting entry. The operation is irreversible, so it should be used with caution. This endpoint only performs the deletion and does not return any information about the deleted meeting or provide options for rescheduling. It's important to note that this action may affect student schedules and course planning, so proper communication with course participants is advised before deleting a meeting.
Delete data source by idDeletes a specific data source from the Blackboard Learn platform. This endpoint should be used when an administrator needs to permanently remove a data source, such as those related to users, courses, or enrollments, from the system. It's crucial to use this endpoint with caution as the deletion is irreversible and may impact associated data. This operation is particularly useful for cleaning up obsolete or erroneous data sources, but should not be used on active data sources that are still in use. Note that deleting a data source does not automatically remove the data that was previously associated with it.
Delete lti domain by idDeletes a specific LTI (Learning Tools Interoperability) domain from the Blackboard learning management system. This endpoint is used to remove an existing domain configuration, which may include associated LTI tool integrations and settings. It should be used when an institution needs to discontinue the use of a particular LTI domain, perhaps due to changes in tool usage, administrative restructuring, or cleanup of unused integrations. Caution should be exercised when using this endpoint, as deletion is permanent and may affect existing course content or tool accessibility that relies on the deleted domain.
Delete course content attachmentDeletes a specific attachment from a content item within a course in Blackboard Learn. This endpoint should be used when an instructor or authorized user needs to remove an attachment from course materials. It permanently removes the specified attachment from the content, and this action cannot be undone. The endpoint requires precise identification of the course, content item, and attachment using their respective IDs. It's important to note that this operation only removes the attachment and does not affect the content item itself or other attachments.
Delete gradebook column by idDeletes a specific gradebook column from a course in the Blackboard Learn system. This endpoint should be used when an instructor or administrator needs to permanently remove a column from the gradebook, such as when a graded item is no longer relevant or was created in error. It's important to note that this action is irreversible and will permanently delete all associated grade data for all students in the course. Use this endpoint with caution, as it may have significant implications for course grading and student records. This operation cannot be undone, so it's recommended to have a backup of the data before proceeding with the deletion.
Delete course grade notation by idDeletes a specific grade notation from a course's gradebook in Blackboard Learn. This endpoint should be used when an instructor or administrator needs to remove an existing grade notation that is no longer relevant or was created in error. It permanently removes the specified grade notation from the system, so it should be used with caution. This operation cannot be undone, so it's important to verify the correct gradeNotationId before deletion. The endpoint does not return the deleted data; it typically only confirms the successful deletion or reports an error if the deletion fails.
Delete gradebook period by course idDeletes a specific gradebook period from a course in the Blackboard Learning Management System. This endpoint allows administrators or instructors to remove a grading period that is no longer needed or was created in error. It should be used when restructuring the gradebook's temporal organization or when cleaning up unused grading periods. This operation is permanent and cannot be undone, so it should be used with caution. The endpoint does not return the deleted data, only performs the deletion action.
Delete course group by idsThis endpoint deletes a specific group from a course in the Blackboard learning management system. It is used to remove a group that is no longer needed or has been created in error. The operation is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful for course administrators or instructors who need to manage group structures within their courses. It should not be used to temporarily disable a group; instead, it permanently removes the group and all associated data from the course. Note that this action does not affect the individual user accounts of group members, only the group itself within the specified course.
Delete user from course groupRemoves a specific user from a particular group within a course in the Blackboard learning management system. This endpoint is used when an instructor or administrator needs to remove a student or participant from a group, perhaps due to course changes, group reorganization, or student withdrawal. It's important to note that this action only removes the user from the specified group, not from the entire course. Use this endpoint with caution, as it immediately revokes the user's access to group-specific content and collaborations.
Delete course content adaptive release ruleRemoves a specific group from a criterion within an adaptive release rule for a particular content item in a Blackboard course. This endpoint is used to modify the access conditions for course content by eliminating a group's inclusion in the release criteria. It should be used when an instructor or course administrator wants to adjust the visibility rules for content, specifically by removing a group's access under certain conditions. This operation is permanent and immediately affects the adaptive release settings for the specified content.
Delete group set in courseThis endpoint deletes a specific group set within a course in the Blackboard learning management system. It permanently removes the entire group set, including all associated groups and their memberships, from the specified course. This operation should be used with caution as it cannot be undone and will affect all students assigned to groups within the set. The endpoint is particularly useful for instructors or administrators who need to restructure group assignments or remove outdated group configurations. It should not be used to temporarily disable group functionality, as deletion is permanent. Note that this operation does not affect the course structure itself or any other group sets within the course.
Delete course from category listRemoves a specific course from a designated category within the Blackboard Learning Management System (LMS) catalog. This endpoint is used when you need to disassociate a course from a particular category, which can be useful for reorganizing the course catalog, updating course classifications, or managing access control based on categories. It should be used cautiously as it permanently removes the course-category association. This operation does not delete the course itself from the system; it only removes the association between the course and the specified category. The endpoint requires precise identification of both the category (through categoryType and categoryId) and the course (through courseId) to ensure accurate removal of the correct association.
Delete course message by idThis endpoint deletes a specific message within a course in the Blackboard learning management system. It should be used when an instructor or authorized user needs to remove a particular message from a course's communication thread. The deletion is permanent and cannot be undone, so it should be used with caution. This tool is particularly useful for managing course content, removing outdated or inappropriate messages, or maintaining a clean communication environment within the course. Note that this action may be subject to user permissions, and the ability to delete messages might be restricted to certain roles within the course.
Delete institutional hierarchy node by nodeidDeletes a specific node from the institutional hierarchy in Blackboard Learn. This endpoint should be used when an administrator needs to remove a node, such as a department, school, or program, from the institution's organizational structure. It permanently removes the specified node and its association within the hierarchy. Caution should be exercised when using this endpoint, as deleting a node may have cascading effects on courses, users, or other entities associated with that node. It's important to note that this operation cannot be undone, so it should only be used when you are certain that the node and its data are no longer needed.
Delete institution node adminRemoves an administrator's access from a specific node in the institutional hierarchy of Blackboard Learn. This endpoint should be used when you need to revoke administrative privileges for a user at a particular level of the institution's structure. It's particularly useful for managing access control and maintaining the security of the institutional hierarchy. The operation is permanent and immediate, so it should be used with caution. This endpoint does not delete the user account itself; it only removes the administrative role for the specified node. Note that this action may affect the user's ability to manage courses, users, or other resources associated with the given node and its sub-nodes.
Delete specific course nodeRemoves a specific course from a designated node in the institutional hierarchy of Blackboard Learn. This endpoint is used for managing the organizational structure of courses within an institution's Blackboard environment. It allows administrators to disassociate a course from a particular hierarchical node, which can be useful for reorganizing content, archiving old courses, or correcting misplaced courses. The operation is permanent and should be used with caution, as it may affect the visibility and accessibility of the course within the institutional structure. This endpoint does not delete the course itself from the system; it only removes the association between the course and the specified hierarchical node.
Delete user from institutional nodeThis endpoint removes a specified user from a particular node within the Institutional Hierarchy of Blackboard Learn. It is used to disassociate a user (such as a student, faculty member, or staff) from a specific organizational unit (e.g., school, department, or program) in the institution's structure. This operation is typically performed when a user no longer needs access to or association with a particular part of the institution, such as when a student changes departments or a faculty member leaves a specific program. The endpoint does not delete the user from the system entirely, but only removes their association with the specified node. It's important to note that this action may affect the user's access rights and visibility within the Blackboard Learn environment related to the specific node.
Delete user observerThis endpoint removes a specific observer from a user's list of observers in the Blackboard learning management system. It is used to terminate the observer-user relationship, revoking the observer's ability to monitor or view the specified user's activities and information. The endpoint should be called when an institution or administrator needs to discontinue an observer's access to a particular user's data, such as when a parent's observing privileges for a student are revoked or when a teacher's monitoring of a student is no longer required. This operation is irreversible, and re-establishing the observer relationship would require creating a new connection. The endpoint does not provide any information about the observer or user; it simply performs the deletion of the relationship.
Delete lt i placement by idThis endpoint deletes a specific Learning Tools Interoperability (LTI) placement from the Blackboard Learn platform. LTI placements define where and how external learning tools are integrated within the Blackboard user interface. Use this endpoint when you need to remove an LTI tool integration from a specific location in the Blackboard environment. This action is permanent and cannot be undone, so it should be used with caution. The deletion will remove the placement configuration but does not affect the LTI tool provider registration itself. Be aware that removing a placement may impact users who rely on the tool at that specific location within Blackboard.
Delete pronoun by idDeletes a specific pronoun entry from Blackboard by pronoun ID.
Delete course assessment questionDeletes a specific question from an assessment within a Blackboard course. This endpoint allows instructors or course administrators to remove individual questions from existing assessments, which can be useful for updating or refining assessment content. The operation is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful when modifying assessments after they've been created, such as removing outdated or incorrect questions. It should not be used to temporarily hide questions; instead, consider using other Blackboard features for that purpose. Note that deleting a question may affect the overall structure and scoring of the assessment, so it's important to review and adjust the assessment settings after using this endpoint.
Delete course rubricDeletes a rubric from a Blackboard Learn course without returning the rubric. Used rubrics cannot be deleted by default; force deletion also deletes their evaluations and associations.
Delete rubric associationDeletes a rubric association in a Blackboard course. An association used to evaluate an activity or question can be force-deleted, after which dependent gradebook grades are considered manual.
Delete term by termidThe DeleteTerm endpoint removes a specific academic term from the Blackboard learning management system. It should be used when an administrator needs to permanently remove a term that is no longer needed, such as an outdated or erroneously created term. This operation is irreversible and will delete all associated data for the specified term, including course associations and enrollment information. It's crucial to use this endpoint with caution, as it may have far-reaching consequences on the institution's academic records and student data. Before deletion, ensure that all necessary data has been backed up or migrated if required.
Delete user by idThis endpoint permanently deletes a user account from the Blackboard Learn platform. It should be used when an administrator needs to remove a user's access and information from the system, such as when a student graduates or an employee leaves the institution. The deletion is irreversible, so it should be used with caution. Once deleted, all associated data, including course enrollments, submissions, and personal information, will be permanently removed. This endpoint does not provide a way to archive or temporarily deactivate a user; it only performs a complete deletion. It's crucial to verify the userId and ensure that any necessary data has been backed up before proceeding with the deletion.
Delete user from course meetingsDeletes a user's attendance records for a specified Blackboard course. Use caution when removing attendance data.
Delete group in courseThis endpoint deletes a specific group within a course in the Blackboard Learning Management System. It is used to remove a group that is no longer needed or to clean up the course structure. The operation is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful for instructors or administrators who need to manage course organization, especially when restructuring group activities or at the end of a term. It does not provide any information about the deleted group or its members; it simply removes the group from the course.
Get gradebook column detailsRetrieves detailed information about a specific gradebook column for a particular course in the Blackboard learning management system. This endpoint allows educators and administrators to access the configuration and content of individual grading components within a course's gradebook. It should be used when detailed information about a specific grading column is needed, such as its name, points possible, visibility settings, or associated assignments. The endpoint does not modify any data and is suitable for read-only operations. It's important to note that this endpoint only provides information for a single column and does not return data about student grades or submissions.
Download course content attachmentDownloads a specific attachment from a Blackboard course content item and returns it as a downloadable file.
Update user grade details by courseUpdates a specific user's grade information within a course's gradebook column in the Blackboard learning management system. This endpoint allows instructors or authorized users to modify various aspects of a student's grade, including the textual representation, numerical score, private notes, student feedback, and exemption status. It's particularly useful for manual grade columns or when grades have been manually overridden in attempt-based columns. The endpoint provides flexibility in grading practices, enabling detailed feedback and grade management for individual students within a course.
Enroll Course With PermissionsUpdates a user's enrollment details in a specific Blackboard Learn course. This endpoint allows for modifying various aspects of a user's course membership, including their role, availability status, and association with cross-listed courses. It's particularly useful for managing instructor assignments, adjusting student access, and organizing cross-listed course enrollments. The endpoint should be used when changes to a user's course enrollment are required, such as changing their role, updating their availability, or moving them between cross-listed courses. It does not provide functionality for initial course enrollment or complete removal of a user from a course.
Fetch course category by idRetrieves category associations for a specified Blackboard course or organization, with optional category expansion and pagination.
Retrieve rubric evaluation by associationRetrieves the evaluations associated with a specific rubric for a particular course and rubric association in the Blackboard learning management system. This endpoint is designed for instructors, administrators, or authorized personnel to access and review assessment data based on predefined rubric criteria. It should be used when detailed evaluation information is needed for a specific course, rubric, and its application context (association). The endpoint provides a targeted view of assessment data, focusing solely on the evaluations tied to the specified parameters. It does not modify any data and is intended for read-only access to evaluation information.
Fetch rubric evaluation for group attempt columnRetrieves rubric evaluations for a specific group attempt in a Blackboard course gradebook column, including evaluation identifiers, submission dates and score information.
Retrieve user grades for course columnRetrieves user grades for a specified Blackboard course gradebook column. Results may be paginated; the grade status field is unreliable.
Get course meeting download urlRetrieves a download URL for a Blackboard course's attendance data file.
Fetch learning session dataLists active Blackboard Learn user sessions, with optional expansion of user details. Results may be paginated and can include user ID, start and last-access times, and mobile status.
Get course content adaptive release group criteriaRetrieves the groups associated with a specific criterion of an adaptive release rule for a particular content item within a Blackboard course. This endpoint is used to get information about which groups are part of the conditions for releasing content based on the adaptive release feature. It's particularly useful when you need to review or audit the adaptive release settings for a course, especially the group-based criteria. The endpoint does not modify any data and is intended for read-only operations. It's important to note that this endpoint only retrieves group information for a single criterion and does not provide a comprehensive view of all adaptive release rules or criteria for the content item.
Fetch user criteria from course content ruleLists user associations for a specific adaptive release criterion on a Blackboard course content item. Results may be paginated.
Retrieve course content adaptive release rule criterionRetrieves detailed information about a specific criterion within an adaptive release rule for a particular content item in a Blackboard Learn course. This endpoint allows instructors or administrators to examine the conditions set for releasing content to students. It should be used when reviewing or troubleshooting adaptive release settings, or when preparing to modify existing criteria. The tool provides granular access to individual criterion details, enabling precise management of content availability. Note that this endpoint only retrieves information and does not modify any settings.
Get announcement by idRetrieves a specific announcement from the Blackboard Learn platform using its unique identifier. This endpoint allows users to fetch detailed information about a single announcement, such as its title, content, publication date, and author. It's particularly useful when you need to display or process information about a known announcement. The endpoint should be used when you have the specific ID of an announcement and require its full details. Note that this endpoint only retrieves existing announcements and cannot be used to create, modify, or delete announcements.
List announcementsLists Blackboard system announcements, with optional filters for creator, title and dates, and pagination.
Retrieve course attempt fileRetrieves metadata for a specific file attached to a course gradebook attempt, including its name and, when available, viewer or download URLs.
Fetch gradebook attempt filesLists metadata for files attached to a course gradebook attempt, including names and available viewer or download URLs. Supports pagination.
Retrieve attempt receipt by idRetrieves an attempt receipt by ID, including submission information, related identifiers and receipt status when available.
Get attendance recordReturns a Course Meeting Attendance information for the given meeting and user Id. The "course.attendance.VIEW" entitlement is required to view a Course Meeting Attendance. **Since**: 3500.7.0
Get attendance records by meeting idReturns a list of Course Meeting Attendance for a given meeting id. The "course.attendance.VIEW" entitlement is required to view a Course Meeting attendance. **Since**: 3500.7.0
Retrieve user meetings in courseRetrieves a user's meeting attendance records for a specified course or organization. Results can include attendance status and record timestamps.
Fetch calendar item by type and idRetrieves detailed information about a specific calendar item from the Blackboard learning management system. This endpoint allows you to fetch data for a single calendar entry, such as an event, appointment, or assignment, based on its type and unique identifier. Use this when you need to access or display comprehensive information about a particular item in a user's or course's calendar. The endpoint is particularly useful for building integrations that sync calendar data or for displaying detailed event information in external applications. Note that this endpoint only retrieves existing calendar items and cannot be used to create, modify, or delete calendar entries.
Get calendar itemsRetrieves calendar items from the Blackboard Learn platform. This endpoint allows users to fetch a list of calendar events, which may include course schedules, assignment deadlines, and institution-wide events. It provides access to the integrated calendar system within Blackboard Learn, enabling applications to synchronize with or display Blackboard calendar data. This tool is particularly useful for building applications that need to display or manage academic schedules, deadlines, and events from Blackboard. Note that the response may include various types of calendar items such as course events, office hours, and gradebook deadlines. The endpoint does not provide functionality for creating, updating, or deleting calendar items; it is read-only.
Get calendarsGet the list of calendars. This endpoint will return all calendars viewable by the user. All users can request a list of calendars viewable to them. **Since**: 3400.9.0
Retrieve category type detailsRetrieves a list of categories from the Blackboard catalog based on the specified category type. This endpoint is used to fetch organized groups of resources or content within the Blackboard Learn platform, such as course categories, program categories, or departmental categories. It's particularly useful for applications that need to display or manage the structure of educational content within Blackboard. The endpoint should be used when you need to populate category listings, build navigation menus, or gather information about how content is organized in the Blackboard system. Note that this endpoint only provides category information and does not return the actual content within those categories.
Fetch category details by idRetrieves detailed information about a specific category in the Blackboard catalog system. This endpoint allows users to access category data based on the category type and its unique identifier. It is useful for obtaining metadata, structure, or any other relevant information about a particular category within the educational content organization. The endpoint should be used when detailed information about a specific category is needed, such as when populating category details in a user interface or when synchronizing category information with external systems. It provides a focused view of a single category and does not return information about items within the category or related categories.
Retrieve course child detailsRetrieves detailed information about a specific child course within a parent course in the Blackboard Learn platform. This endpoint is useful for accessing hierarchical course structures, allowing developers to fetch data about nested or sub-courses. Use this when you need to gather information about a particular child course, such as its name, description, or specific attributes related to its parent-child relationship. The endpoint requires both the parent course ID and the child course ID to uniquely identify the requested child course within the Blackboard Learn system.
Retrieve catalog category childrenRetrieves the child categories of a specified parent category within the Blackboard catalog system. This endpoint allows users to navigate through the hierarchical structure of categories, which is crucial for organizing and accessing educational content. It should be used when exploring the category tree, building category-based navigation, or when needing to list subcategories of a specific parent category. The endpoint is particularly useful for applications that need to mirror or interact with Blackboard's content organization structure. Note that this endpoint only provides direct children of the specified parent category and does not recursively fetch all descendants.
Retrieve children goals by idRetrieves the child elements (sub-goals, tasks, or related items) of a specified goal in the Blackboard learning management system. This endpoint is used to fetch the hierarchical structure of educational objectives, allowing users to view and manage the breakdown of a parent goal into its component parts. It's particularly useful for educators and administrators who need to track the progress of complex, multi-layered learning objectives or course structures. The endpoint should be used when there's a need to understand the sub-components of a specific goal or to navigate through the goal hierarchy. It will not provide detailed information about the parent goal itself, only its immediate children.
Retrieve grade attempt by course and column idRetrieves detailed information about a specific attempt for a gradebook column within a course in the Blackboard Learn system. This endpoint allows users to access individual submission data, such as scores, comments, or other relevant information associated with a student's attempt on a particular graded item. It is particularly useful for instructors or administrators who need to review or analyze individual student performances on assignments or assessments. The endpoint should be used when detailed information about a specific submission is required, rather than aggregate data for the entire column or course.
Retrieve gradebook attemptsRetrieves attempt data for a specific gradebook column within a course in the Blackboard Learn platform. This endpoint allows users to access detailed information about student attempts for a particular assessment or assignment. It's useful for analyzing student performance, tracking submission patterns, and gathering data for educational analytics. The endpoint should be used when detailed information about student interactions with a specific gradebook item is needed, but it won't provide an overview of the entire gradebook or course structure.
Retrieve user gradebook columnRetrieves a specific user's grade for a particular gradebook column in a Blackboard course. This endpoint is useful for accessing individual student performance data within a course, allowing for targeted grade retrieval and analysis. It should be used when detailed grade information for a single student on a specific assignment or gradebook entry is needed. The endpoint provides focused access to gradebook data, which is particularly valuable for generating individual student reports, conducting performance reviews, or integrating with external grade management systems.
Get last changed grade column for userRetrieves the last-changed user grade for a specified gradebook column in a Blackboard course. The response contains grade information, including the associated user and relevant grade dates when available.
List gradebook columns for usersRetrieves user data associated with a specific gradebook column for a given course in Blackboard. This endpoint allows educators and administrators to access detailed information about students' performance or participation in a particular graded item or category. It should be used when there's a need to analyze or report on student data for a specific gradebook column, such as assignment scores or participation grades. The endpoint provides a focused view of user data, limited to the context of the specified course and gradebook column, and does not include overall course performance or data from other columns.
Get course gradebook group attemptsLists group attempts for a Blackboard course gradebook column, for reviewing group submissions and grades. Supports filtering by group, user, status and dates, along with pagination and field selection.
Retrieve course content by idsRetrieves specific content within a Blackboard course using the course ID and content ID. This endpoint allows users to access detailed information about a particular content item, such as a lecture, assignment, or resource, within the context of a specific course. It's useful for applications that need to display or process individual course materials. The endpoint should be used when detailed information about a specific piece of course content is required, rather than for retrieving a list of all content in a course. Note that this endpoint only provides information about the content and does not include user-specific data like submission status or grades.
Retrieve course content childrenRetrieves child content items under a specified Blackboard course content item. By default it returns immediate children; an option includes deeper descendants, and filters can narrow the results.
Retrieve contentcollection resourceRetrieves a specific resource from a content collection in Blackboard Learn. This endpoint allows developers to access detailed information about a particular resource, such as a document, video, or other educational material, stored within Blackboard's content management system. It is particularly useful when you need to retrieve metadata or content details for a known resource, perhaps to display it in a custom interface or to verify its properties. The endpoint requires a valid resourceId to function correctly and will likely return comprehensive details about the resource, including its name, type, size, and associated metadata. However, it may not provide the actual content of the resource, depending on Blackboard's implementation.
Get course content group detailsRetrieves the association between a specific course content item and group in Blackboard. The response identifies the associated content and group.
Retrieve course content groupsRetrieves the groups associated with a specific content item within a Blackboard course. This endpoint is useful for understanding the group structure or permissions related to particular course content. It should be used when you need to list all groups that have access to or are associated with a specific piece of content in a course. The endpoint does not modify any data and is intended for read-only operations. Note that it does not provide detailed information about the groups themselves, only their association with the specified content.
Retrieve course contentsRetrieves course content items in Blackboard, including their structure and details. Results default to immediate children; recursive retrieval can include deeper descendants, and filters and pagination can limit the returned results.
Retrieve course detailsRetrieves detailed information about a specific course in the Blackboard Learn system. This endpoint is used to access course data such as title, description, availability, enrollment information, and other course-specific attributes. It's particularly useful for applications that need to display or process course information outside of the Blackboard Learn interface. The endpoint should be used when detailed information about a single course is required, rather than for bulk operations or listing multiple courses. Note that the exact fields returned may depend on the user's permissions and the course's configuration within Blackboard Learn.
List child courses for a given courseRetrieves cross-listed child courses associated with a specified parent course. Child course details can be expanded in the response.
Get Course Column LogsRetrieves the log entries for a specific gradebook column within a Blackboard course. This endpoint provides a detailed history of all actions and changes made to the specified gradebook column, including grade modifications, updates to comments, and other relevant activities. It is particularly useful for auditing purposes, allowing educators and administrators to track and review the complete history of a gradebook column. The endpoint should be used when there's a need to investigate grading discrepancies, verify changes, or maintain a record of grading activities for compliance and transparency. Note that this endpoint only returns logs for a single gradebook column; to get a comprehensive view of all gradebook activities, you may need to make multiple calls for different columns.
Retrieve course alignments by idRetrieves goal alignments for a specified Blackboard course, linking goals to course content and other alignable resources. Results can be filtered by goal or resource and paginated.
Get course gradebook logsRetrieves the gradebook logs for a specific course in the Blackboard learning management system. This endpoint provides a historical record of all gradebook-related activities and changes within the specified course. It's particularly useful for instructors and administrators who need to audit grade modifications, track changes over time, or investigate discrepancies in student grades. The logs typically include information such as the date and time of changes, the user who made the changes, and the nature of the modifications (e.g., grade updates, column additions, or deletions). This tool should be used when detailed tracking of gradebook activities is required, but it does not provide real-time grade data or allow for grade modifications.
Get course meeting detailsRetrieves details of a specific Blackboard course meeting, such as its title, description, schedule and external link. An optional field selector limits the details requested.
Get course meetingsRetrieves a list of meetings associated with a specific course in the Blackboard learning management system. This endpoint is used to fetch details about scheduled meetings, such as virtual classroom sessions, office hours, or other course-related events. It provides educators and students with up-to-date information on upcoming or past meetings for a particular course. The endpoint should be used when you need to display or manage the meeting schedule for a course. It will not provide information about meetings across multiple courses or institution-wide events. The response likely includes meeting titles, dates, times, durations, and possibly attendance information, though the exact details are not specified in the schema.
Retrieve users from courseRetrieves course memberships for a specified Blackboard course, including user IDs, roles and availability. User details can be expanded when available, subject to permissions.
Get course resourceRetrieves metadata for a specific file or folder resource in a Blackboard course. File metadata may include a download URL.
Get course resource childrenRetrieves a list of child resources associated with a specific resource within a Blackboard course. This endpoint is useful for exploring the hierarchical structure of course materials, such as folders, documents, or assignments nested within a parent resource. Use this when you need to display or process the contents of a particular course resource. The endpoint returns only direct child resources and does not provide details about the parent resource itself or any grandchild resources. It's particularly helpful for building course content navigation or for analyzing the structure of course materials.
Retrieve course role by role idRetrieves detailed information about a specific course role in Blackboard Learn using its unique identifier. This endpoint is used to fetch the properties, permissions, and settings associated with a particular role within a course. It's essential for understanding the access levels and capabilities assigned to different user types in the Blackboard learning environment. Use this endpoint when you need to review or verify the configuration of a course role, such as instructor, teaching assistant, or student. The returned data can be used for role management, troubleshooting access issues, or ensuring proper permissions are set for different user categories. Note that this endpoint only provides read access to role information and cannot be used to modify role settings.
Fetch course roles informationRetrieves a list of available course roles in the Blackboard Learn system. This endpoint allows users to fetch all predefined roles that can be assigned to users within courses. It is useful for administrators and developers who need to understand the available role options when managing course memberships or setting up integrations. The endpoint does not create, modify, or delete roles; it only provides read access to the existing role definitions. Use this endpoint when you need to display role options, validate role assignments, or gather information about the roles structure in your Blackboard Learn instance.
List coursesLists Blackboard courses and organizations, with optional filters, sorting and pagination. Returned course metadata can include identifiers, names and descriptions.
Retrieve course content release criteriaRetrieves the criteria associated with a specific adaptive release rule for a particular content item within a Blackboard course. This endpoint allows instructors or administrators to view the conditions that must be met for students to access the content. It's useful for reviewing or auditing adaptive release settings without modifying them. The endpoint doesn't provide information about whether students have met the criteria, only the criteria themselves. Use this when you need to understand or verify the access conditions for specific course content.
Get cross list set by course idRetrieves the cross-listed course set for a specified course in Blackboard Learn. This endpoint is used to obtain information about courses that are linked together, typically representing different sections of the same course that share content. It's particularly useful for administrators or instructors managing multiple sections of a course with shared materials. The endpoint returns details about the cross-listed courses, which may include their IDs, names, and other relevant information. Use this when you need to identify or manage courses that are part of a cross-listed set. Note that this endpoint only provides information about the cross-listed courses and does not modify any course data.
Retrieve user sessions by user idRetrieves the active or historical sessions for a specific user in the Blackboard Learn platform. This endpoint allows developers to access detailed information about a user's interaction with the system, including login times, duration, and potentially other session-related data. It is particularly useful for tracking user activity, analyzing engagement patterns, or implementing custom analytics for educational institutions. The endpoint should be used when there's a need to monitor or report on individual user activity within the Blackboard environment. It does not provide real-time session management capabilities, such as terminating active sessions.
Get data source by idRetrieves detailed information about a specific data source within the Blackboard Learn platform. This endpoint allows you to access metadata and configuration details for a particular data source, which can be crucial for understanding the origin and nature of data within the Blackboard ecosystem. Use this endpoint when you need to verify data source information, troubleshoot data-related issues, or integrate external systems with Blackboard Learn. The tool provides a comprehensive view of a single data source but does not modify or create new data sources. It's particularly useful for administrators and developers working on data management and integration tasks within educational institutions using Blackboard.
Fetch data source listRetrieves a list of data sources available in the Blackboard learning management system. This endpoint provides information about various data sources that can be used for integrating external systems, reporting, or data analysis within the Blackboard platform. It should be used when you need to obtain an overview of all available data sources or when preparing to work with specific data sets in Blackboard. The endpoint does not modify any data and is safe for frequent calls, but be aware that the list of data sources may be extensive for large institutions.
Retrieve coursediscussion detailsRetrieves detailed information about a specific discussion thread within a course on the Blackboard Learn platform. This endpoint allows users to access the content, metadata, and other relevant details of a discussion, enabling them to view or analyze discussion activities without directly accessing the Blackboard user interface. It should be used when detailed information about a particular discussion is needed, such as for reporting, content management, or integration with other educational tools. The endpoint requires both the course ID and discussion ID to be specified, ensuring precise retrieval of the desired discussion data.
Get discussion messages for courseRetrieves a page of messages for a specific Blackboard course discussion, including posts and replies. Results can be filtered by group, user, status, read state, and dates, and paginated to browse the conversation.
Get course discussion threadsRetrieves a page of discussions for a Blackboard course. Results can be filtered by title or gradable status and paginated; discussion objects may include topic content and metadata.
Retrieve lti domain details by domainidRetrieves detailed information about a specific LTI (Learning Tools Interoperability) domain within the Blackboard Learn system. This endpoint is used to fetch configuration details, status, and other relevant information for a particular LTI domain integration. It's particularly useful for administrators and developers who need to manage or troubleshoot LTI tool integrations with Blackboard. The endpoint should be used when specific information about an LTI domain is required, such as verifying its configuration or checking its current status. It will not modify any domain settings; it's a read-only operation.
Retrieve lti domain listingsRetrieves a list of LTI (Learning Tools Interoperability) domains registered with the Blackboard Learn platform. This endpoint is used to obtain information about the external tools and platforms that have been integrated with Blackboard using the LTI specification. It provides essential data for managing and troubleshooting LTI integrations within the Blackboard Learn environment. The returned list of domains can be used to verify the correct configuration of LTI tools, ensure security by checking authorized domains, and audit the current integrations. This endpoint is particularly useful for administrators and developers working on LTI integrations with Blackboard Learn.
Get course content attachmentRetrieves metadata for a specific attachment associated with a Blackboard course content item.
Get course content attachmentLists attachment metadata for a specific Blackboard course content item. Results may be paginated.
Retrieve course message foldersRetrieves a list of message folders for a specific course in the Blackboard learning management system. This endpoint allows users to access the organizational structure of course messages, providing an overview of how communication is categorized within the course. It should be used when needing to understand the message folder hierarchy or before performing operations on specific message folders. The endpoint returns only the folder structure and does not include the actual messages within these folders. It's particularly useful for applications that need to display or manage course communication organization.
Get goal alignments by goalidRetrieves the alignments associated with a specific educational goal in the Blackboard learning management system. This endpoint allows users to fetch the learning activities or assessments that are linked to a particular goal, enabling educators and administrators to understand how curriculum elements are mapped to educational objectives. It should be used when there's a need to review or analyze the alignment of course content with specific learning outcomes. The endpoint provides a comprehensive view of how a goal is integrated into the curriculum but does not modify any alignment data.
Retrieve goal by idRetrieves a specific Blackboard learning goal, including its text, availability and associated goal set or category information.
Get learning goalsRetrieves a list of educational goals in Blackboard Learn. Supports filtering by category, goal set, and goal type, as well as pagination, sorting, and field selection.
Retrieve goal set by idRetrieves detailed information about a specific goal set within the Blackboard Learning Management System. This endpoint allows educators and administrators to access comprehensive data about a particular collection of educational objectives or targets. It should be used when there's a need to review, analyze, or integrate goal set information into other educational processes or reports. The endpoint provides a snapshot of the goal set's current state and structure but does not allow for modifications. It's particularly useful for tracking progress, aligning curricula, or generating reports on educational objectives across courses or programs.
Get goal set category by idRetrieves detailed information about a specific goal category within a designated goal set in the Blackboard Learn platform. This endpoint allows users to access the properties and metadata of a particular goal category, which is useful for understanding the structure and organization of goals within a course or program. It should be used when detailed information about a specific goal category is needed, such as when displaying category details or preparing for goal management tasks. The endpoint does not modify any data and is intended for read-only operations.
Retrieve goal setsRetrieves a list of goal sets from Blackboard Learn. Results may be paginated, and the request supports pagination, sorting, and field selection.
Fetch goal set category goalsThis endpoint retrieves a list of goals associated with a specific category within a goal set in the Blackboard learning management system. It allows administrators and educators to access and review the goals that have been set for a particular category, enabling them to align course objectives with institutional goals. The endpoint is useful for goal management, curriculum planning, and ensuring educational alignment across courses and programs. It should be used when there's a need to review, assess, or report on the goals within a specific category of a goal set. Note that this endpoint only provides read access to the goals and does not allow for creation, modification, or deletion of goals.
Retrieve course gradebook categoriesRetrieves the list of gradebook categories for a specific course in the Blackboard learning management system. This endpoint allows users to fetch the organizational structure of a course's gradebook, including the categories used to group different types of assessments and assignments. It is particularly useful for understanding how grades are organized within a course, which can aid in grade calculations, reporting, and overall course management. The endpoint should be used when there's a need to view or analyze the grading structure of a particular course, but it will not provide actual grade data for students.
Retrieve gradebook category by idRetrieves a specific gradebook category in a Blackboard course, including its ID and title.
Retrieve gradebook column by course and column idsRetrieves detailed information about a specific gradebook column within a particular course in the Blackboard learning management system. This endpoint allows users to access the properties and settings of an individual grading column, such as its name, description, points possible, and grading type. It should be used when detailed information about a specific grading component is needed, for example, when reviewing or auditing the grading structure of a course. The endpoint provides read-only access and does not allow modification of the column data. It's particularly useful for instructors, teaching assistants, or administrators who need to verify or analyze the setup of their course gradebook without making changes.
List course gradebook columnsRetrieves a list of gradebook columns for a specified course in the Blackboard Learn environment. This endpoint allows users to access detailed information about the structure and components of a course's gradebook. It should be used when there's a need to view or analyze the grading schema for a particular course, such as when integrating external grading tools or performing academic audits. The endpoint provides a comprehensive overview of how grades are organized within the course but does not include actual student grades or scores. It's particularly useful for understanding the weighting and categorization of different assignments and assessments within the course.
Retrieve course grade notationRetrieves detailed information about a specific grade notation within a course's gradebook in the Blackboard Learning Management System. This endpoint allows users to fetch individual grade notation data, which may include the notation symbol, description, and associated grading rules. It should be used when precise information about a particular grade notation is needed, such as during grade reviews or when updating grading policies. The endpoint does not modify any data and is suitable for read-only operations. Note that it only returns data for a single grade notation; to retrieve multiple notations, separate API calls would be required for each.
List grade notations for courseRetrieves grade notation definitions for a specific Blackboard course's gradebook. Results may be paginated and can be used for reporting or display.
Get gradebook schema for courseRetrieves the gradebook schemas for a specific course in the Blackboard learning management system. This endpoint allows developers to access the structure and format of the gradebook data for a given course, which is crucial for understanding how grades are organized and stored within Blackboard. It can be used when integrating external grading systems, developing custom grade reporting tools, or when needing to understand the grading structure of a particular course. The endpoint returns the schemas without actual grade data, focusing solely on the structural aspects of the gradebook.
Get gradebook periods by course and period idRetrieves a specific grading period in a Blackboard course, including its title, position, date settings, and start and end dates.
Retrieve course gradebook periodsRetrieves the gradebook periods for a specified course in the Blackboard learning management system. This endpoint allows users to fetch information about the temporal structure of grade entries and assessments within a particular course. It is useful for understanding how the course's grading is organized over time, which can be essential for course management, grade reporting, and student performance tracking. The endpoint should be used when there's a need to review or analyze the grading structure of a specific course, particularly for administrative or reporting purposes. It does not modify any data and is meant for read-only operations.
Retrieve course group by idsRetrieves information about a specific group in a Blackboard course, including its name, description, availability and enrollment settings.
Retrieve user from course groupRetrieves a specific user's membership in a course group. The response contains the user ID and may include user identifiers.
List course group usersRetrieves a list of users belonging to a specific group within a Blackboard Learn course. This endpoint is used to access user information for group-based activities, collaborative assignments, or administrative purposes. It provides details about the members of a particular group, which can be useful for instructors or administrators managing course activities. The endpoint should be used when you need to obtain user data for a specific group context, rather than for the entire course. It's important to note that this endpoint only provides user information within the scope of the specified group and course, and does not offer details about user activities or performance outside of this context.
Fetch course groups by idLists groups associated with a Blackboard course for course management and reporting. Results can be filtered and paginated, and may include paging information for additional results.
Retrieve course group informationRetrieves the properties and configuration of a specific Blackboard course group set, including its name, description and availability.
List course group setsRetrieves a list of groups within a specific group set for a given course in the Blackboard learning management system. This endpoint allows educators and administrators to access detailed information about the groups created within a particular group set, facilitating management of student collaborations and assignments. It should be used when there's a need to view or analyze the structure of groups within a course, such as for attendance tracking, assignment distribution, or organizing collaborative activities. This endpoint is particularly useful for applications that need to synchronize group data with external systems or generate reports on course organization.
Retrieve course group setsLists group sets associated with a Blackboard course. Results can be filtered and paginated, and may include paging information for additional results.
Get system infoRetrieves Blackboard Learn system information, including the site ID, tenant ID and region used with platform services. These values may initially be null after installation.
Retrieves institution role by idRetrieves an institutional role by ID in Blackboard, including its role key, name, description, and custom status.
List institution rolesLists institution roles in Blackboard Learn, with optional filtering, sorting, and pagination.
Retrieve loginas sessionsLists Blackboard login-as sessions, with optional pagination and sorting. Results can include the impersonator, impersonated user, session identifier, creation time, and reason.
Get user course by idRetrieves detailed information about a specific user within a particular course in the Blackboard learning management system. This endpoint is used to fetch user-specific data in the context of a given course, which may include enrollment status, role in the course, progress, or other relevant details. It should be used when you need to access or verify a user's information or status within a specific course. This endpoint is particularly useful for generating reports, checking user progress, or managing course-specific user data. Note that it only provides information for a single user-course combination and does not return data about the user across multiple courses or course-wide user lists.
Get courses for categoryRetrieves a list of courses associated with a specific category in the Blackboard catalog. This endpoint allows users to fetch course information based on the category type and category ID, providing a way to browse or search for courses within a particular organizational structure. It's useful for applications that need to display course offerings for a given department, subject area, or other categorical groupings. The endpoint should be used when you need to present users with a filtered view of courses or when populating course selection interfaces tied to specific categories in the Blackboard system.
Retrieve participants of course messageRetrieves participants for a specific Blackboard course message, including their participation type. Results can be filtered and paginated, and participant user details can be expanded.
Retrieve discussion message replyRetrieves replies to a specific message in a Blackboard course discussion. Results can be filtered by group, user, status, read state, and dates, and are paginated.
Fetch messages for course idRetrieves course messages from a Blackboard course or organization folder. The folder defaults to inbox and can be selected by type or custom name; results are paginated.
Get hierarchy node by node idRetrieves detailed information about a specific node within the institutional hierarchy of Blackboard. This endpoint allows users to fetch data about a particular component or entity in the educational institution's structure. It should be used when specific information about a node, such as its attributes, relationships, or metadata, is needed. The endpoint is useful for applications that require navigation or display of the institutional hierarchy, or for integrations that need to synchronize node data with external systems. Note that this endpoint only provides information for a single node; to retrieve the entire hierarchy or multiple nodes, separate API calls may be necessary.
Retrieve admin info by nodeid and useridRetrieves the administrative status of a specific user for a particular node within the Blackboard institutional hierarchy. This endpoint allows you to check whether a user has administrative privileges for a given organizational unit, such as a department or course. Use this endpoint when you need to verify a user's administrative role or permissions within a specific part of the institution's structure. The endpoint provides information about the user's admin status but does not modify any permissions. It's particularly useful for access control, auditing, or displaying user roles in management interfaces.
Retrieve node adminsRetrieves the list of administrators associated with a specific node in the Blackboard institutional hierarchy. This endpoint is used to fetch administrative information for a particular organizational unit, such as a department, school, or program within an educational institution. It provides insights into the management structure and helps in understanding who has administrative access to various parts of the institutional hierarchy. This tool is particularly useful for system administrators, IT staff, or institutional managers who need to review or manage administrative roles within the Blackboard system.
List child nodes by node idRetrieves child nodes of a specified Blackboard institutional hierarchy node. By default it returns immediate children; recursive search can include deeper descendants, with paginated results.
Retrieve courses for institutional nodeRetrieves course and organization associations for a specified Blackboard institutional hierarchy node. Results may be paginated, can be filtered by course or organization, and can include expanded course details.
Fetch institutional hierarchy nodesRetrieves information about the nodes within the institutional hierarchy of a Blackboard learning environment. This endpoint allows users to fetch data representing the organizational structure of an educational institution, such as departments, schools, or other administrative units. It's particularly useful for understanding the layout and relationships of different entities within the institution's Blackboard setup. The endpoint should be used when needing to map out the institutional structure, populate organization charts, or when integrating systems that require knowledge of the institution's hierarchy. Note that this endpoint only provides structural information and may not include detailed data about each node's operations or members.
Retrieve course nodesRetrieves institutional hierarchy node associations for a specified Blackboard course or organization. Results may be paginated and can include expanded node details and primary association status.
Get user nodes for user idRetrieves institutional hierarchy node associations for a specified Blackboard user. Results may be paginated and can include expanded node details.
Retrieve users in institutional nodeRetrieves a list of users associated with a specific node in the Blackboard Learn institutional hierarchy. This endpoint allows administrators and authorized users to fetch user information within the context of the institution's organizational structure. It is particularly useful for managing user access, roles, and permissions at different levels of the institutional hierarchy. The endpoint should be used when there's a need to audit or review user assignments within a specific department, faculty, or sub-institution. It provides a comprehensive view of user associations but does not modify any user data. Note that the response may be paginated for large user sets, and additional API calls might be necessary to retrieve the complete list of users for nodes with a high number of associated accounts.
Retrieve observees of user profileRetrieves a list of observees associated with a specific user in the Blackboard learning management system. This endpoint is used to fetch information about individuals or entities that the specified user is authorized to observe or monitor within the system. It is particularly useful for scenarios where a user, such as a parent or guardian, needs to access data about students they are responsible for. The endpoint returns details about the observees, which may include their identifiers, names, and potentially other relevant information depending on the system's configuration and privacy settings. It should be used when there's a need to gather information about the relationship between a user and their observees in an educational context.
Get user observers by idRetrieves the list of observers associated with a specific user in the Blackboard learning management system. This endpoint is used to fetch information about individuals or entities that have been granted observer access to a particular user's activities and progress. It's particularly useful for administrators, instructors, or guardians who need to monitor a student's performance and engagement within the Blackboard platform. The endpoint returns details about each observer, which may include their roles, permissions, and relationship to the observed user. This tool should be used when there's a need to review or manage the observers for a given user, such as during student progress reviews or when updating access permissions.
Retrieve lti placement by idRetrieves detailed information about a specific LTI (Learning Tools Interoperability) placement within the Blackboard Learn platform. This endpoint allows developers and administrators to fetch the configuration, settings, and integration details for a particular LTI tool placement identified by its unique placementId. Use this endpoint when you need to inspect or verify the setup of an LTI tool within Blackboard courses or content areas. The returned data may include information such as the tool's name, description, launch URL, and custom parameters. This endpoint is particularly useful for troubleshooting LTI integrations or gathering information for reporting purposes.
Fetch lti placementsRetrieves LTI placements in Blackboard Learn, with optional filters for properties such as name, type, course, domain, and availability. Results are paginated and can include placement IDs, names, and descriptions.
Fetch privacy policiesRetrieves Blackboard and institution privacy policy URLs, optionally for a specified locale.
Retrieve proctoring service by idRetrieves detailed information about a specific proctoring service integrated with Blackboard Learn. This endpoint allows users to fetch configuration details, availability status, and other relevant information for a particular online exam proctoring solution. It's particularly useful for administrators and instructors who need to verify or review the settings of a proctoring service before configuring exams. The endpoint should be used when specific details about a proctoring service are required, such as during exam setup or troubleshooting integration issues. Note that this endpoint only provides information about the service itself and does not include data about individual proctored exams or student sessions.
Retrieve proctoring servicesRetrieves a list of available proctoring services integrated with the Blackboard Learn platform. This endpoint is part of Blackboard's Proctoring Services Framework and is designed to support online examination security. It should be used when administrators or instructors need to view the proctoring options available for configuring secure assessments in the Ultra Course View. The endpoint provides information about the integrated third-party proctoring solutions but does not include details about individual exam configurations or student data. Note that the actual implementation of proctoring services may require additional setup and configuration within the Blackboard Learn environment.
Retrieve pronouns informationRetrieves a paginated list of system-wide Blackboard pronoun entries, including their names and statuses. The list can be used to inspect pronoun options for user profiles.
Retrieve assessment questionRetrieves detailed information about a specific question within an assessment for a particular course in the Blackboard learning management system. This endpoint allows users to access question content, type, scoring information, and other relevant details. It should be used when detailed information about a single question is needed, such as for review, editing, or analysis purposes. The endpoint does not modify the question; it only provides read access to the existing data. Note that the response will not include student answers or performance data related to the question.
Get assessment questions by course and assessment idRetrieves a list of questions for a specific assessment within a Blackboard course. This endpoint allows users to access the questions associated with a particular assessment, such as a quiz, test, or assignment, in a given course. It's useful for instructors or administrators who need to review, analyze, or export assessment questions. The endpoint requires both a course identifier and an assessment identifier to pinpoint the exact set of questions to retrieve. It should be used when detailed information about assessment questions is needed, but it does not provide information about student responses or scores. Note that the accessibility of this data may depend on the user's permissions within the Blackboard system.
Get content collection resources childrenRetrieves a list of child resources for a specified parent resource within the Blackboard content collection. This endpoint is used to navigate through the hierarchical structure of educational content, allowing users to explore sub-items or nested resources within a given parent resource. It's particularly useful for applications that need to display or manage the content structure of Blackboard courses or materials. The endpoint returns only direct children of the specified resource, not the entire subtree, making it suitable for building tree-like navigation or content exploration features. Note that this endpoint does not provide the actual content of the resources, only their metadata and structural information.
Fetch content collection resourcesRetrieves a paginated list of Blackboard Learn content collection resource metadata, with optional filters for resource type, dates, size, and creator.
Get review status of user in course contentRetrieves the review status of a specific content item for a particular user within a Blackboard Learn course. This endpoint is useful for instructors or administrators to track whether a student has reviewed or interacted with a particular piece of course content. It can be used to monitor student engagement, ensure compliance with course requirements, or identify students who may need additional support. The endpoint does not modify any data and is intended for read-only operations. It's important to note that this endpoint only provides the review status and does not give detailed information about the user's interaction with the content.
Get course performance content review statusRetrieves paginated content review performance for a Blackboard course, optionally filtered by user. Results can include each user's reviewed count and the course's reviewable content count.
Retrieve rubric association for courseRetrieves detailed information about a specific rubric association within a Blackboard Learn course. This endpoint allows users to access the configuration and application details of a rubric to a particular assessment or assignment. It is particularly useful for understanding how grading criteria are applied to specific coursework, enabling instructors and administrators to review and manage assessment structures. The tool should be used when detailed information about rubric implementation for a specific assignment is needed, such as during course setup, grading processes, or when analyzing assessment methodologies. It does not modify any data and is solely for retrieval purposes.
Retrieve course rubric associationsRetrieves the associations of a specific rubric within a given course in Blackboard Learn. This endpoint allows users to fetch information about how a particular rubric is linked to various course elements such as assignments, discussions, or other assessable items. It's useful for understanding the application of rubrics across different components of a course, aiding in consistent assessment practices. The endpoint requires both a course ID and a rubric ID to pinpoint the exact associations being queried. It does not create, modify, or delete associations; it only provides read access to existing rubric-course element relationships.
Get rubric associations for gradebook columnsRetrieves the rubric associations for a specific gradebook column within a Blackboard course. This endpoint allows users to access detailed information about how rubrics are connected to a particular grading column, which is crucial for understanding the assessment criteria and grading structure. It should be used when there's a need to review or analyze the rubric setup for a specific gradable item in a course. The tool is particularly useful for instructors, course designers, or administrators who need to ensure that the appropriate rubrics are linked to the correct gradebook columns. Note that this endpoint only provides information about existing associations and does not allow for creating, modifying, or deleting these associations.
Get course rubric by course idRetrieves a specific rubric for a given course in the Blackboard learning management system. This endpoint allows users to access detailed information about a rubric, including its criteria, scoring methods, and any associated metadata. It is particularly useful for instructors or administrators who need to review or integrate rubric data into other systems or workflows. The endpoint should be used when detailed rubric information is required for a known course and rubric combination, but it will not modify or create new rubrics.
Retrieve rubric evaluation detailsRetrieves detailed information about a specific rubric evaluation within a Blackboard course. This endpoint allows users to access the assessment data, including scores and feedback, for a particular rubric evaluation associated with a course component. It is useful for instructors reviewing assessments, students viewing their feedback, or administrators analyzing evaluation data. The endpoint requires specific identifiers for the course, rubric, association, and evaluation to pinpoint the exact evaluation record. It should be used when detailed evaluation data is needed, but won't provide an overview of multiple evaluations or allow modifications to the evaluation.
Retrieve rubric evaluation for attemptRetrieves a page of rubric evaluations for a specific gradebook attempt in a Blackboard course. Results include evaluation identifiers, association, scores and submission date when available.
Fetch rubric list for courseRetrieves a page of rubrics for a Blackboard course, including available titles, descriptions and rubric types. Results can be filtered by creation or modification date.
Retrieve course content adaptive release rulesRetrieves a page of adaptive release rules associated with a specific Blackboard course content item, including rule IDs and titles.
Get upload settingsRetrieves the current upload settings for the Blackboard Learn platform. This endpoint allows administrators and authorized users to fetch the configuration parameters related to file uploads within the Blackboard system. It provides information about various aspects of file upload handling, such as maximum file size limits, allowed file types, storage configurations, and any other relevant upload-related settings. This tool should be used when there's a need to review or verify the current upload policies and constraints in place for the Blackboard instance. It does not modify any settings; it only returns the existing configuration.
Retrieve sis dataset log by idRetrieves SIS integration log messages for a specified dataset UID in Blackboard Learn. Results are paginated and can be filtered by log level; the default level is Error.
Retrieve system role by idRetrieves a specific Blackboard system role by ID, including available role identifiers, name, description and whether it is custom.
List system rolesRetrieves a page of Blackboard system roles, with optional role ID and custom-role filters. Results include available identifiers, names, descriptions and custom status.
Retrieve task by idRetrieves detailed information about a specific system task in the Blackboard Learn platform. This endpoint allows developers to fetch the current status, details, and metadata of an individual task identified by its unique taskId. It should be used when monitoring or tracking the progress of system-level operations, such as batch processes, system updates, or administrative functions. The endpoint provides up-to-date information about the task but does not allow modification of the task itself. It's particularly useful for integrations that need to synchronize with Blackboard's system tasks or provide status updates to users.
Fetch course task detailsRetrieves a specific course task's status and progress, including its start time, with optional response field selection.
Retrieve term by idRetrieves detailed information about a specific academic term in the Blackboard Learn system. This endpoint is used to fetch comprehensive data about a term, such as its name, start date, end date, and any associated metadata. It's particularly useful for applications that need to synchronize term information or display term details to users. The endpoint should be used when specific term information is required, rather than a list of all terms. Note that this endpoint only provides details for a single term; to get information about multiple terms, separate requests must be made for each termId.
Fetch terms listRetrieves a list of academic terms or information about specific terms in the Blackboard learning management system. This endpoint provides access to term definitions, including start and end dates, term names, and other relevant metadata. It's useful for applications that need to synchronize academic calendars, manage course schedules, or provide term-based information to users. The endpoint supports pagination and field selection, allowing for efficient data retrieval and reduced payload sizes when only specific term information is needed. It should be used when building integrations that require up-to-date term information or when displaying term-related data in external applications connected to Blackboard.
Retrieve toc items by course idRetrieves the Table of Contents (TOC) items for a specified course in the Blackboard learning management system. This endpoint provides access to the structured organization of educational materials within a course, including modules, lessons, assignments, and other content types. It should be used when needing to display or analyze the content structure of a course, such as for building a course navigation interface or auditing course materials. The endpoint returns only the TOC structure and does not include the actual content of the items. It's particularly useful for applications that need to understand or replicate the course layout without accessing the full content details.
Fetch oauth2 tokeninfoRetrieves detailed information about a specified OAuth2 token used for authentication in the Blackboard Learn API. This endpoint allows developers to verify the validity, scope, and associated details of an access token. It should be used when an application needs to check the current state or permissions of a token, such as during user session management or before making API calls. The endpoint does not refresh or modify the token; it only provides read-only information about the token's current state.
Get institutional node tool informationRetrieves a paginated list of tools and their settings for a specified tool type at a Blackboard institutional hierarchy node. Supports response field selection.
Retrieve course resources by idRetrieves a list of resources associated with a specific course in the Blackboard Learning Management System (LMS). This endpoint allows users to access educational materials, such as assignments, readings, and other study materials, that are linked to a particular course. It should be used when there's a need to fetch all available resources for a given course, which can be useful for building course content viewers, resource management tools, or for synchronizing course materials with external systems. The endpoint does not provide the actual content of the resources, but rather metadata and references to access them. It's important to note that the accessibility of resources may depend on the user's permissions within the Blackboard system.
Fetch types of goal setsRetrieves a list of available goal set types in the Blackboard Learn system. This endpoint allows users to fetch information about the different categories or classifications of goal sets that can be created or managed within the learning management system. It is useful for understanding the structure and organization of educational objectives or learning outcomes in Blackboard. The endpoint should be used when planning to create new goal sets or when needing an overview of the existing goal set categories. It does not provide specific goals or content within these sets, only the types or categories available for organization.
Retrieve user by idRetrieves a specific Blackboard Learn user's profile, including fields such as name, contact information and system roles. The data returned may be subject to privacy settings and access controls.
Retrieve user avatar by useridRetrieves avatar information for a specified Blackboard Learn user. The response can include a view URL and avatar source; accessing the image via the URL may require following a redirect.
Retrieve gradebook entry for user in courseRetrieves detailed gradebook information for a specific user within a particular course in the Blackboard learning management system. This endpoint allows educators, administrators, or authorized users to access individual student performance data, including grades, assignments, and other relevant gradebook entries. It should be used when detailed grade information for a single student in a specific course is required, such as for progress monitoring or generating individual reports. The endpoint does not provide aggregate data for multiple students or courses and cannot be used to modify gradebook entries.
Retrieve user courses by idRetrieves course memberships for a specific Blackboard Learn user, with filtering, sorting and pagination. Results include membership information and can include expanded course details.
Get user pronunciation audioRetrieves the pronunciation audio associated with a specific user's profile in Blackboard Learn. This endpoint allows applications to access the audio file that contains the correct pronunciation of the user's name. It should be used when there's a need to play or display the audio pronunciation of a user's name, such as in user directory listings, class rosters, or personalized greetings. The audio file returned may be in a common audio format (e.g., MP3, WAV). If no pronunciation audio has been set for the user, the endpoint may return a 404 error or an empty response. This tool does not upload or modify the pronunciation audio; it is for retrieval purposes only.
Retrieve users listThe GetUsersEndpoint retrieves user information from the Blackboard Learn system. This endpoint allows you to fetch a list of users with their associated details, supporting various query parameters for filtering, sorting, and pagination. It's particularly useful for applications that need to synchronize user data, manage user accounts, or display user information within an educational context. The endpoint returns user data in a structured format, likely including fields such as user IDs, usernames, email addresses, and other relevant profile information. While it provides comprehensive user data, it does not modify user information - separate endpoints would be required for user creation, updates, or deletion. Use this endpoint when you need to access user data for reporting, user management, or integration purposes within your Blackboard-connected application.
Retrieve system version informationRetrieves the current version information of the Blackboard Learn system. This endpoint should be used when developers or administrators need to check the specific version of the Blackboard instance they are working with. It's particularly useful for ensuring compatibility with other tools or services that integrate with Blackboard, or for troubleshooting version-specific issues. The endpoint returns version details of the system, which may include the major, minor, and patch version numbers. It does not provide information about individual components or modules within the Blackboard system, focusing solely on the overall system version.
Retrieve user gradebook columnRetrieves a specific user's grade for a particular gradebook column in a Blackboard Learn course. This endpoint allows instructors or administrators to fetch individual grade entries, providing a targeted way to access student performance data. It's particularly useful for generating individual student reports, verifying grade entries, or integrating with external grading systems. The endpoint returns the grade value and potentially additional metadata such as submission date or feedback. It should be used when precise, individual grade information is needed, rather than for bulk grade retrieval across multiple students or columns.
List users in course groupLists users belonging to a specific Blackboard course group using the v1 endpoint. Results contain membership user IDs and may include user identifiers; pagination is supported.
Create new course with json inputCreates a new course in the Blackboard Learn system with specified attributes and settings. This endpoint allows for the creation of both academic courses and organizational units, with extensive customization options for course properties, availability, enrollment methods, and localization. It should be used when setting up new courses or organizations within Blackboard, either manually or as part of an automated provisioning process. The endpoint provides flexibility in course setup, supporting both Ultra and Classic course views, various availability and enrollment options, and integration with external systems through data source and external ID fields. However, it's important to note that some settings are specific to either Ultra or Classic courses, and certain parameters may have interdependencies or require specific permissions to modify.</description> </invoke>
Update user in course groupSends a request to associate a user with a specific group in a Blackboard course using the v1 group membership endpoint.
Fetch goal set categoriesRetrieves the categories associated with a specific goal set in the Blackboard learning management system. This endpoint is used to fetch the organizational structure of educational objectives within a predefined set of goals. It should be used when needing to understand or display the categorization of learning objectives for a particular goal set, such as when building course structures or reporting on educational outcomes. The endpoint returns only the categories within the specified goal set and does not provide detailed information about the goals themselves. This tool is particularly useful for administrators and instructors who need to manage and organize educational goals across courses or programs.
List Gradebook ColumnsLists gradebook column metadata for a Blackboard course, optionally filtered by content item. Results may be paginated and can include names, points possible, and creation and modification dates.
Get group details from course apiRetrieves details of a specific group within a Blackboard course, including its name, description, availability, and enrollment settings.
Retrieve user in course groupRetrieves a specific user's group membership in a Blackboard course, including the user ID and associated user identifiers.
Retrieve course listLists courses and organizations in Blackboard Learn using the public v2 API, with optional filters, sorting, and pagination.
Add course gradebook columnCreates a new grade column in a Blackboard course's gradebook. This endpoint allows instructors or administrators to add a new column for recording and managing student grades within a specific course. It provides extensive customization options for grading methods, score calculations, student visibility, and anonymous grading. Use this endpoint when setting up a new assignment, exam, or other gradable item in a course. It's particularly useful for configuring complex grading scenarios or when integrating external grading systems with Blackboard.
Patch gradebook columnThis endpoint allows for updating specific properties of an existing grade column within a course's gradebook in the Blackboard Learn platform. It provides granular control over various aspects of the grade column, including its metadata, scoring configuration, visibility to students, and grading settings. The PATCH operation supports partial updates, meaning you can modify individual properties without affecting others. This is particularly useful for adjusting grade column settings throughout the academic term, such as changing due dates, modifying scoring models, or updating anonymous grading configurations. Note that this endpoint does not create new grade columns or delete existing ones; it is specifically for modifying properties of an already existing grade column identified by the courseId and columnId.
Modify announcement detailsThis endpoint allows you to update an existing course announcement in the Blackboard Learn platform. It can modify the announcement's title, body content, draft status, and availability settings. The body content supports rich text formatting using BbML (Blackboard Markup Language), enabling the creation of visually appealing and structured announcements. Use this endpoint when you need to edit or refine an announcement's content, change its visibility, or update its publication status. It's particularly useful for correcting errors, adding new information, or adjusting the timing of announcement visibility to students.
Patch hierarchy node tool settingsUpdates availability, locking and applicability settings for a tool at an institutional hierarchy node, including guest and observer settings. By default, changes apply to new Original courses and all Ultra courses; an option extends them to existing Original courses.
Post discussion message in coursePosts a new message to a specific discussion within a Blackboard Learn course. This endpoint allows users to contribute to course discussions by adding new messages, supporting both general course discussions and group-specific discussions. It provides options for setting the message status, enabling features like draft saving and soft deletion. The endpoint is essential for facilitating student engagement and collaborative learning through structured, asynchronous communication within the Blackboard platform.
Delete child course associationRemoves a child course association from a parent course in Blackboard Learn, separating the courses. The separation style controls whether child enrollments are removed from the parent or left there as unavailable.
Delete user from course groupThis endpoint removes a specific user from a designated group within a course in Blackboard Learn. It is used when an administrator or instructor needs to adjust group membership, such as when a student changes project teams or is no longer part of a specific study group. The operation is final and will immediately revoke the user's access to group-specific resources and activities. It should be used cautiously, as removing a user from a group may affect their ability to participate in group-related coursework. This endpoint does not remove the user from the course itself, only from the specified group within the course.
Delete course announcement by idThis endpoint deletes a specific announcement within a course in the Blackboard Learn platform. It allows administrators or authorized users to remove outdated, incorrect, or unnecessary announcements from a course, helping to maintain clear and relevant communication. The operation is irreversible, so it should be used with caution. This tool is particularly useful for content clean-up, managing course information, and ensuring that students only see current and applicable announcements.
Delete gradebook column in courseDeletes a specific gradebook column from a course in Blackboard Learn. This endpoint allows instructors or administrators to remove a column from the gradebook, which may be necessary for course restructuring or correcting errors in grade calculations. It should be used with caution as the deletion is permanent and may affect overall grade calculations. This operation is available in both Ultra and Original experiences of Blackboard Learn. Note that this action cannot be undone, and all associated grade data for the column will be permanently removed.
Delete discussion message by idDeletes a specified message in a Blackboard course discussion. An option can hard-delete the message and its replies; otherwise a message with replies is soft-deleted, while a message without replies is hard-deleted.
Obtain oauth2 token via postObtains an OAuth2 token for authenticating and authorizing requests to the Blackboard API. This endpoint is essential for securing access to Blackboard's resources and should be used before making any API calls that require authentication. The token obtained from this endpoint is typically valid for a limited time and should be refreshed periodically. This endpoint supports both client credentials flow for server-to-server interactions and authorization code flow for user-centric operations. It's important to note that the token should be kept secure and not exposed to end-users or in client-side code.
Download course gradebook attempt fileRequests a specific file submitted with a Blackboard gradebook attempt, identified by course, attempt and file IDs. Use it to access a student's submission for grading or review.
Update discussion message statusUpdates a specific message within a course discussion on the Blackboard platform. This endpoint allows for modifying the status and/or content of an existing message. It can be used to publish drafts, soft-delete messages, or update the body text of a message. The update is partial, meaning you can modify either the status, the body, or both without affecting the other fields. This endpoint is particularly useful for moderating discussions, editing messages for clarity, or managing the visibility of messages within a course context. Note that updating a message's status may affect its visibility to other users in the discussion.
Retrieve course gradebook column attemptsRetrieves attempt data for a specific gradebook column within a Blackboard course. This endpoint allows instructors and administrators to access detailed information about student attempts on assignments, tests, or other graded activities associated with the specified gradebook column. It is particularly useful for tracking student progress, analyzing performance trends, and gathering data for assessment purposes. The endpoint should be used when detailed information about individual student attempts is needed, such as for grading, providing feedback, or generating reports. It does not modify any data and is intended for read-only access to attempt information.
Get course gradebook attemptRetrieves detailed information about a specific attempt for a gradebook column in a Blackboard course. This endpoint allows instructors or authorized users to access individual student attempt data, including scores, submission dates, and potentially feedback. It's particularly useful for tracking student progress, reviewing specific submissions, or addressing grade inquiries. The endpoint should be used when detailed information about a single attempt is needed, rather than for bulk data retrieval or when an overview of all attempts is required.
Update admin node rolesUpdates the roles of an administrative user for a specific node within the institutional hierarchy of Blackboard. This endpoint allows you to modify the permissions and responsibilities of an admin user by assigning or changing their roles for a particular node. It is used when you need to adjust an admin's access or capabilities within a specific part of the institution's structure. The endpoint requires the node ID, user ID, and a list of roles to be assigned. It's important to note that this operation replaces the existing roles for the user at the specified node, so all desired roles should be included in the request.
Delete course by courseidDeletes a specified Blackboard course or organization; this destructive operation should be used with caution. Course files are deleted by default, but the request can specify whether to remove them.
Patch adaptiverelease criterionSends an update request for a specific adaptive release criterion on a Blackboard course content item. The tool does not accept criterion settings as input.
Modify system announcement detailsThis endpoint allows you to update an existing System Announcement in Blackboard. It provides the ability to modify the announcement's title, content (using BbML formatting), availability settings, and display options. Use this endpoint when you need to change the content or visibility of a specific announcement, such as extending its duration, updating its message, or adjusting where it appears in the Blackboard interface. The update is partial, meaning you only need to include the fields you want to change. Be cautious when updating availability settings, as changes may immediately affect the announcement's visibility to users.
Update attendance recordUpdate the Course Meeting Attendance data for the given Course/Organization. The "course.attendance.MODIFY" entitlement is required to update a Course Meeting Attendance. The "course.attendance.VIEW" entitlement is required to view a Course Meeting attendance. **Since**: 3500.7.0
Update attendance recordsCreates or updates a meeting attendance record for a specified user in a course or organization. Both course.attendance.CREATE and course.attendance.MODIFY entitlements are required; without them, no records are created or modified.
Patch calendar item by type and idUpdates a Blackboard calendar item by type and ID, including details, recurrence settings, and LTI links. It can update a single item or an entire recurring series; series updates require a full recurrence object, while single-item updates must omit recurrence.
Update category details by typeUpdates specific details of a category in the Blackboard catalog system. This endpoint allows modification of various category attributes such as title, description, front page visibility, availability, access restrictions, and associated institution roles. It's used to manage and organize the catalog structure, controlling how categories are presented and accessed within the Blackboard learning environment. The endpoint requires specifying both the category type and ID in the URL path to target the correct category for updates. It's particularly useful for administrators or content managers who need to refine category settings or adjust access permissions.
Update attempt status in gradebookThis endpoint allows for updating specific attributes of a gradebook attempt for a particular course, column, and attempt ID. It is used to modify various aspects of a student's submission, including its status, score, feedback, and grading properties. The PATCH operation enables partial updates, allowing instructors to change only the necessary fields without affecting others. This tool is particularly useful for managing the grading process, providing feedback to students, and handling special grading scenarios such as exemptions or multiple attempts. It should be used when there's a need to update any information related to a specific gradebook entry, but not for creating new attempts or retrieving attempt information. Note that some status values are deprecated, and changing the reconciliationMode requires also providing a new score.
Patch grade information for userThe UpdateGrade endpoint allows instructors to modify various aspects of a student's grade for a specific course and gradebook column in the Blackboard Learning Management System. This PATCH operation enables overriding grades, adding instructor notes and feedback, marking grades as exempt from course grade calculations, and associating predefined grade notations. It's particularly useful for handling manual grade entries, overriding automatically calculated grades, and managing special grading circumstances. The endpoint should be used when there's a need to adjust individual student grades outside of the standard grading process, provide detailed feedback, or apply special grading considerations. It's important to note that this endpoint modifies existing grade entries and does not create new ones; it should not be used for initial grade submissions.
Patch course contentThis endpoint allows you to update existing content within a specific Blackboard Learn course. It provides extensive control over content properties, including title, body, description, position, availability, and more. Use this endpoint when you need to modify course content attributes, reorganize content structure, or adjust content visibility and access settings. The endpoint is particularly useful for content management tasks such as updating content details, moving content between folders, setting adaptive release rules, or changing content types. Note that while you can update various aspects of the content, you cannot create new content or delete existing content using this endpoint. Be aware of the specific content handler types supported and their respective documentation when dealing with specialized content types.
Patch course details by idUpdates an existing course in Blackboard Learn with the provided information. This endpoint allows modification of various course attributes including basic details, availability settings, enrollment options, and localization preferences. It's particularly useful for administrators or instructors who need to adjust course settings after initial creation, such as changing the course name, updating its availability, or modifying enrollment options. The endpoint supports partial updates, meaning only the fields that need to be changed should be included in the request body. Note that some settings, like allowing guests or observers, are only modifiable for Classic courses, while others apply to both Classic and Ultra courses. Care should be taken when using the 'closedComplete' status, as it can limit further updates, especially for Ultra courses.
Patch course meeting detailsThis endpoint allows you to update the details of a specific meeting within a course in the Blackboard learning management system. It uses a PATCH request to modify one or more attributes of an existing meeting, such as its title, description, start and end times, or associated external link. This tool is particularly useful for making changes to scheduled meetings, correcting information, or updating virtual meeting links without having to recreate the entire meeting entry. When using this endpoint, you can selectively update only the fields that need to be changed, leaving other attributes untouched. Note that you must have appropriate permissions within the Blackboard system to modify course meetings, and changes made through this API will be reflected in the course's meeting schedule visible to students and instructors.
Patch data source by external idThis endpoint allows for updating specific attributes of an existing data source in the Blackboard system. It uses the PATCH method to apply partial modifications to a data source identified by its unique dataSourceId. The primary use case is to update the external ID or description of a data source, enabling better synchronization with external systems and improved documentation within Blackboard. This endpoint should be used when there's a need to modify data source metadata without changing its core functionality or relationships within the system. It's particularly useful for maintaining accurate and up-to-date information about data sources used in educational institutions integrated with Blackboard.
Update course discussion detailsUpdates a specific discussion forum within a Blackboard Learn course. This endpoint allows for partial updates to discussion properties such as title, availability, grading options, and the main topic content. It is used when modifying existing discussions without creating a new one or altering read-only metadata. The endpoint supports BbML formatting for rich text content in the topic body. Note that this operation only affects the discussion settings and main topic; it does not modify individual replies or nested messages within the discussion thread.
Update lti domain configurationThis endpoint allows updating an existing LTI (Learning Tools Interoperability) domain configuration in the Blackboard Learn platform. It is used to modify various settings related to LTI tool integration, including domain information, security settings, user data sharing preferences, and service permissions. The endpoint is particularly useful when changes need to be made to an existing LTI tool configuration, such as updating the primary domain, modifying data sharing settings, or adjusting service permissions. It provides fine-grained control over how the LTI tool interacts with Blackboard Learn and what data it can access. This endpoint should be used carefully, as changes to these settings can significantly impact the functionality and security of the LTI integration.
Update gradebook columnThis endpoint updates a specific grade column in a course's gradebook. It allows modification of column details, scoring settings, availability, grading options, and rubric associations. Use it to adjust existing columns for changes in course structure or grading policies. Note that some fields are version-specific or limited by course type (Classic vs Ultra).
Patch grade notation for courseThis endpoint allows you to update an existing grade notation for a specific course in the Blackboard learning management system. It's used to modify the performance code and/or description associated with a grade notation in the course's gradebook. This tool is particularly useful for administrators or instructors who need to adjust grading scales or clarify the meaning of certain grade notations. The update is performed by specifying the course ID and grade notation ID in the path, and providing the new code and/or description in the request body. Note that this endpoint only updates existing grade notations and cannot be used to create new ones or delete existing notations.
Update grading period infoUpdates a specific grading period within a course's gradebook in the Blackboard Learn system. This endpoint allows for modification of various attributes of an existing grading period, including its title, description, position in the gradebook, date settings, and temporal coverage. It's used when course instructors or administrators need to adjust grading period details after initial creation, such as extending deadlines or reorganizing the gradebook structure. The endpoint provides flexibility in updating individual fields without requiring all parameters to be specified. It's particularly useful for managing the chronological structure of a course and associating gradable items with specific time frames.
Update course group informationUpdates an existing group within a specified course in the Blackboard Learn system. This endpoint allows for modification of various group properties including its external ID, name, description, availability status, and enrollment settings. It's particularly useful for adjusting group configurations after initial creation, such as changing visibility, updating enrollment limits, or modifying the signup process. The endpoint supports rich text formatting through BbML for descriptions, enabling detailed and well-formatted group information. Use this when you need to alter any aspect of an existing group's setup or presentation to students within a course.
Update course group detailsUpdates a group set in a Blackboard course, including its name, description, availability and enrollment settings. Description fields support BbML.
Modify user enrollment in courseUpdates a user's membership details within a specific Blackboard course. This endpoint allows for modifying various aspects of a user's enrollment, including their role, availability, and position within the course hierarchy. It's particularly useful for managing cross-listed courses, updating user roles, and adjusting instructor display orders. The endpoint should be used when changes to a user's course membership are required, such as promoting a teaching assistant to an instructor or updating a user's availability status. It does not provide functionality for adding or removing users from a course.
Update course message read statusUpdates the read status of a specific Blackboard course message, marking it read or unread. The response can include message details.
Update institution node by idThis endpoint allows for updating specific properties of a node within the institutional hierarchy of Blackboard. It is used to modify existing nodes, enabling administrators to keep the institutional structure up-to-date. The endpoint supports partial updates, meaning only the provided fields will be modified. It's particularly useful for renaming nodes, updating descriptions, changing external identifiers, or restructuring the hierarchy by updating parent relationships. However, it cannot be used to create new nodes or delete existing ones. Care should be taken when modifying the parentId to ensure the integrity of the hierarchical structure is maintained.
Update course primary node statusUpdates the association between a course and a node in the Blackboard Learn institutional hierarchy. This endpoint allows you to modify the primary status of a course-node association. Use this when you need to change whether a specific node is the primary association for a course, which can affect how the course is organized and displayed within the institutional hierarchy. This operation is particularly useful for managing course placements in complex institutional structures with multiple hierarchical levels. Note that this endpoint only modifies the 'isPrimary' status and does not create or delete associations.
Update lti placement detailsThis endpoint allows you to update an existing LTI (Learning Tools Interoperability) placement in the Blackboard learning management system. It provides granular control over various aspects of the placement, including its name, description, icon, URL, visibility settings, grading capabilities, and custom launch parameters. Use this endpoint when you need to modify the properties of an existing LTI integration, such as changing its availability, updating its display information, or adjusting its behavior within courses. The endpoint is particularly useful for administrators or instructors who need to fine-tune the integration of external learning tools with Blackboard.
Update pronoun status by idUpdates the information for a specific pronoun in the Blackboard system. This endpoint allows modification of an existing pronoun's name and status, identified by the pronoun ID in the URL path. It's used to manage the list of available pronouns that users can select for their profiles, supporting inclusive identity representation. The endpoint should be used when administrators need to edit pronoun details or change approval statuses. Note that this operation only updates the specified fields and does not affect other pronoun attributes not included in the request.
Modify assessment questionUpdates an existing question in a Blackboard course assessment, including its title, text, points, feedback, and position. Question-type support varies; multiple-choice is marked read-only in the question type schema.
Patch course content review statusUpdates the review status of a specific content item for a particular user within a Blackboard Learn course. This endpoint allows for marking course materials as reviewed or not reviewed, which can be useful for tracking student progress or ensuring compliance with course requirements. It should be used when a user has completed reviewing a piece of content or when their review status needs to be reset. This operation is particularly useful for self-paced learning scenarios or when instructors need to monitor student engagement with course materials. The endpoint is available from Blackboard Learn API version 3700.16.0 onwards.
Patch course rubric detailsUpdates a specific rubric within a Blackboard Learn course. This endpoint allows for modification of various aspects of an existing rubric, including its title, description, type, and detailed grading criteria. It's used to refine assessment tools, adjust grading scales, or modify evaluation criteria without creating an entirely new rubric. The update can encompass changes to the rubric's structure (columns and rows) as well as the specific grading details in each cell. This functionality is particularly useful for instructors who need to fine-tune their assessment methods based on course progression or student feedback. Note that this endpoint modifies an existing rubric; it cannot be used to create a new one or to delete a rubric entirely.
Update rubric association settingsUpdates the properties of a rubric association within a specific Blackboard course. This endpoint allows for modifying various aspects of how a rubric is associated with course content, including its visibility to students and its use in grading. It can be used to adjust rubric settings after initial setup, enabling instructors to fine-tune their assessment strategies. The endpoint is particularly useful for changing rubric visibility or toggling whether the rubric is used for grading without creating a new association. Note that this endpoint updates an existing association; it cannot create new associations or completely remove existing ones.
Update rubric evaluationUpdates a specific rubric evaluation for a course in the Blackboard Learning Management System. This endpoint allows for modifying the scores and feedback for individual criteria within a rubric that has been associated with a course item (such as an assignment or discussion). It is used when an instructor needs to adjust their evaluation of a student's work using a predefined rubric. The update can include changes to scores for different rubric cells and detailed feedback using Blackboard's rich text format (BbML). This endpoint is particularly useful for refining assessments, providing more detailed feedback, or correcting errors in previous evaluations.
Patch term details by termidUpdates an existing term in the Blackboard Learn platform. This endpoint allows modification of various term properties, including its external ID, name, description, availability settings, and duration. It's particularly useful for adjusting term dates, changing access settings, or updating term information after initial creation. The endpoint supports partial updates, meaning you only need to include the fields you want to modify. Note that some settings, like duration type, may require additional fields to be updated simultaneously for consistency.
Update course toc itemUpdates the visibility settings for a specific Table of Contents (TOC) item within a Blackboard course. This endpoint allows you to modify guest and observer access permissions for a particular TOC item. Use this when you need to change who can view certain course content, such as during course setup or when adjusting access throughout the semester. The endpoint only updates visibility settings and does not modify other properties of the TOC item. Note that this operation may affect course accessibility and should be used carefully to ensure compliance with institutional policies.
Update user informationUpdates a user's profile in the Blackboard learning management system. This endpoint allows for partial or complete updates to various aspects of a user's account, including personal information, contact details, system roles, and preferences. It's particularly useful for synchronizing user data with external systems, managing user accounts, or allowing users to update their own information. The endpoint supports granular updates, meaning you can modify specific fields without affecting others. Be cautious when updating sensitive information like passwords or system roles, as these changes can significantly impact the user's access and experience within the Blackboard system.
Create new uploadsCreates an upload record in Blackboard and returns its ID. The tool does not accept file content for transfer.
Get course groupsRetrieves a paginated list of groups associated with a Blackboard course, including group details such as names, descriptions, availability and enrollment settings.

Blackboard

Connect Blackboard

What your chats can do