+
Beyond-Bot.ai + blackboard
Anthology Adopt powered by Pendo allows institutions to gain insights on Blackboard Learn usage and take action through in-app messages, digital walkthrough guides, and tooltips.
What You Can Do with this Integration
Automate Data Entry
Automatically sync new contacts or deals from Beyond-Bot.ai to blackboard.
Enrich Customer Profiles
Use Beyond-Bot.ai to find and add new information to your records in blackboard.
Trigger Workflows
Start automated workflows in blackboard based on conversations with your virtual expert.
Available Actions
Here are the specific actions your virtual expert can perform within blackboard.
Course Announcements Access
Retrieves a list of announcements for a specific course in the blackboard learning management system. this endpoint allows users to access important messages, updates, or notifications related to a particular course. it should be used when there's a need to fetch all announcements or check for recent updates in a 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 Id
Retrieves a specific announcement from a particular course in the blackboard learn system. this endpoint allows users to fetch detailed information about a single announcement, including its content, creation date, and any attachments. it is particularly useful for displaying announcement details in external 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 Parent
This endpoint updates the relationship between a parent course and its child course in the blackboard learning management system. it is used to modify existing course hierarchies, allowing administrators to restructure course organizations or adjust course relationships. the endpoint should be used when there's a need 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 Gradebook
This endpoint allows for the upload and attachment of files to a specific attempt within a course's gradebook in the blackboard learning management system. it is used to associate submitted work, supporting documents, or any relevant files with a student's attempt on an assignment, quiz, or other assessable items. the 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 Code
Initiates the oauth 2.0 authorization code flow for the blackboard api. this endpoint is used to obtain an authorization code, which is a crucial step in the oauth 2.0 authentication process. the authorization code can later be exchanged for an access token, granting limited access to user resources on the blackboard 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 Course
Retrieves the gradebook information for a specific user within a particular course in blackboard. this endpoint allows instructors or authorized personnel to access individual student grade data, including assignment scores, overall course grade, and any custom gradebook columns. it should be used when detailed grade information for a single student in a specific course is needed, such as for progress monitoring or grade reviews. the endpoint does not modify any data and is read-only. note that this tool only provides grade data and does not include other course or user information beyond what's directly related to the gradebook.
Copy Course With Specific Options
The coursecopytool allows you to create a copy of a blackboard course with fine-grained control over which elements are included in the copy. this endpoint is used when you need to duplicate a course, either creating a new course or overwriting an existing one, while selectively choosing which components to transfer. 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 Courseid
This endpoint creates a copy of an existing course in the blackboard learning management system. it allows instructors or administrators to duplicate course content, settings, and structure into a new or existing course. use this endpoint when you need to replicate a course for a new semester, create a template from an existing course, or backup course content. the operation copies all copyable elements of the source course into the target course specified by the courseid. note that this process may take some time for large courses, and certain elements (such as student data or time-sensitive content) may not be copied. the endpoint does not provide real-time progress updates on the copying process.
Create Course Announcement
Creates a new announcement within a specified course in the blackboard learning management system. this endpoint allows instructors or course administrators to post important messages, updates, or notifications to all enrolled students. the announcement can be customized with a title, rich text body using bbml, and 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 List
Retrieves a list of courses from the blackboard learn platform. this endpoint allows developers to fetch information about courses available in the learning management system. it can be used to integrate course data into external applications, create custom dashboards, or sync course information with other systems. the endpoint returns read-only data and does not modify any course information. while it provides a comprehensive list of courses, it may not include detailed information about course content, assignments, or student data, which might require additional api calls. use this endpoint when you need to obtain an overview of courses in the blackboard learn environment, such as for course catalogs or administrative purposes.
Course Endpoint Entitlement Access
Retrieves detailed information about a specific course in the blackboard learn platform using its unique identifier. this endpoint allows users to fetch comprehensive course data, which may include the course name, code, description, enrollment information, instructor details, and other relevant metadata. it's 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 Id
Retrieves detailed information about a specific course in the blackboard learning management system. this endpoint allows users to fetch comprehensive data related to a course, such as its title, description, start and end dates, enrollment information, and other course-specific attributes. it is particularly useful 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 Group
Creates a new group within a specified course in the blackboard learn system. this endpoint allows for detailed customization of group properties, including its name, description, availability, and enrollment settings. it's particularly useful for organizing students into smaller units for collaborative work, 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 Id
Updates the properties of a specific group within a blackboard learn course. this endpoint allows modification of group details such as name, description, availability, and enrollment settings. it's particularly useful for adjusting group configurations after initial creation, managing student access, and controlling 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 Courseid
The patchcourse endpoint allows for updating specific details and settings of an existing course in the blackboard learn system. it is used when modifications to course properties such as name, description, availability, enrollment options, or localization settings are needed. this endpoint supports partial updates, 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 Information
Updates an existing course in the blackboard learn system. this endpoint allows modification of various course attributes including basic information, availability settings, enrollment options, and localization preferences. it's used to adjust course details after initial creation, enabling instructors or 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 Courseid
Deletes a specific course from the blackboard learn platform. this endpoint should be used when an administrator or authorized user needs to permanently remove a course from the system, including all associated content, enrollments, and data. it is particularly useful for cleaning up old or unused courses, or when restructuring the course catalog. caution should be exercised when using this endpoint, as the deletion is irreversible and will result in the loss of all course-related information. this operation may have significant implications for student records and institutional data, so it should only be used after careful consideration and in compliance with institutional policies.
Create A Class Course
Creates a new course in the blackboard learn system with specified settings and configurations. this endpoint allows administrators or instructors to set up a course with various parameters including its basic information, availability, enrollment options, and localization settings. it's particularly useful when setting up new courses for an academic term or creating specialized learning environments. the endpoint requires at minimum a course id and name, but offers extensive customization through optional parameters. it's important to note that some settings, like ultra status, can significantly impact the course's interface and functionality, so careful consideration should be given when configuring these options.
Delete User From Course
Removes a specific user from a particular course in the blackboard learning management system. this endpoint should be used when an administrator or instructor needs to unenroll a student, remove a teaching assistant, or disassociate any user from a course. it's particularly useful for managing course rosters, 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 Rule
This endpoint updates a user-specific criterion within an adaptive release rule for a particular content item in a blackboard course. it allows for fine-tuning of content visibility based on individual user conditions. use this endpoint when you need to modify existing user-based criteria for adaptive release rules, such as changing performance thresholds or adjusting access conditions for a specific student. this tool is specifically for updating existing criteria and should not be used for creating new rules or criteria. note that this endpoint focuses solely on user-specific criteria and does not handle group-based or date-based release conditions.
Create Adaptive Release Criteria By Rule
This endpoint allows for the creation of new adaptive release criteria for a specific rule within a course's content in blackboard. it is used to define conditions under which course content will be made available to students, such as completion of prerequisites, achievement of certain grades, or specific dates. the endpoint should be used when instructors or course designers want to implement or modify conditional access to course materials. it's important to note that this endpoint only creates criteria for existing adaptive release rules and does not create the rules themselves.
Create System Announcement
Creates a new system-wide announcement in the blackboard learn environment. this endpoint allows administrators to compose and configure announcements that can be displayed to users across the platform. the announcement can be customized with rich text content, specific visibility durations, and display locations such 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 Contents
Creates a new assignment within a specified blackboard course. this endpoint allows instructors to set up detailed assignments with customizable settings for availability, grading, and plagiarism detection. it supports rich text instructions using bbml, adaptive release for controlled content visibility, and 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 Status
Adds a user to a specific meeting within a blackboard course and sets their attendance status. this endpoint is essential for managing attendance and user participation in course meetings. it allows instructors or authorized users to update a student's attendance record for a particular meeting. the endpoint should be 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 Items
This endpoint creates a new calendar item in the blackboard platform. it allows users to add various types of events, such as course-related activities, personal appointments, or institution-wide events, to specific calendars within the system. the endpoint supports creating one-time events as well as recurring items 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 Type
Creates a new category in the blackboard catalog system. this endpoint allows administrators to define and organize content categories within the learning management system. use this tool to add a new category with specific properties such as title, description, availability, and access restrictions. it's particularly 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 Course
Creates a new content item within a specified course and parent content in the blackboard learn platform. this endpoint allows for the creation of various types of content, such as documents, external links, folders, and assignments. it provides extensive control over content properties, including title, body, 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 Hierarchy
Creates a new child node within the institutional hierarchy of blackboard learn. this endpoint allows administrators to expand and organize the structure of their educational institution by adding new nodes as children of existing ones. it is particularly useful for creating department, faculty, or program-level nodes within a larger institutional framework. the endpoint requires at least a title for the new node and can optionally include an external id, description, and specific parent id. use this when you need to add a new organizational unit or level to your institution's hierarchy in blackboard.
Submit Gradebook Attempt
Creates a new attempt for a specific gradebook column in a blackboard course. this endpoint allows instructors or authorized users to add a new attempt record for a student's assignment or assessment. it can be used to manually enter grades, provide feedback, or update the status of an attempt. the endpoint is particularly useful for managing individual student submissions, entering grades for offline assignments, or updating attempt statuses in bulk. note that some fields, such as the attemptreceipt, are read-only and will be generated by the system rather than accepted as input.
Post Group Attempts For Gradebook Column
The creategroupattempt endpoint allows for the creation or update of a group attempt for a specific gradebook column in a blackboard learn course. this tool is essential for managing group submissions, tracking their progress, and facilitating the grading process. it supports various aspects of group work, including 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 Course
Creates 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 Association
This 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 Course
Creates 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 Meeting
Creates 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 Id
Creates 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 Course
Creates 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 Configuration
Creates 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 Attachment
Adds an attachment to a specific content item within a blackboard learn course. this endpoint allows developers to programmatically upload and associate files with course materials, enhancing the content available to students. it should be used when integrating external systems with blackboard learn to automate the process of adding supplementary materials, documents, or resources to course content. the endpoint requires specifying both the course and the content item to which the attachment will be added, ensuring precise placement of materials within the course structure. note that this operation likely has size limitations for attachments and may be subject to storage quotas set by the institution's blackboard learn administrator.
Add New Gradebook Column For Course
Creates 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 Gradebook
Creates 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 Schema
Creates 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 Gradebook
Creates 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 Course
Creates 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 Group
This endpoint updates a user's information within a specific group in a blackboard course. it allows administrators or instructors to modify user details, roles, or permissions for a particular user in the context of a course group. use this endpoint when you need to change a user's status, role, or other attributes within a group, such as updating their group membership type or adjusting their group-specific permissions. this operation is specifically for modifying existing user data and should not be used for adding new users to a group or creating new groups. the endpoint requires the course id, group id, and user id to precisely target the user's information in the correct context.
Modify Course Content Adaptive Release Group Criteria
This endpoint updates the criteria for a specific group within an adaptive release rule for a particular content item in a blackboard course. it allows instructors or course administrators to modify how and when course content is made available to different groups of students based on various conditions. use this endpoint when you need to adjust the release criteria for course materials for a specific student group, such as changing date restrictions, grade requirements, or other access conditions. this operation is crucial for maintaining flexible and personalized learning paths within a course. note that this endpoint only updates existing criteria and cannot be used to create new adaptive release rules or groups.
Create Group Set
Creates 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 Course
Creates 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 Details
This endpoint updates an existing course within a specific category in the blackboard catalog. it allows administrators or authorized users to modify course details such as title, description, or other attributes associated with the course. the endpoint should be used when changes need to be made to a course that is already placed within a category in the catalog structure. it's important to note that this endpoint only updates existing courses and cannot be used to create new courses or move courses between categories. proper authorization is likely required to perform this operation, as it involves modifying the course catalog.
Post Course Message With Bbml Support
Creates 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 Reply
Creates 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 Node
Creates 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 Association
This 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 Node
Updates a user's information or association within a specific node of the institutional hierarchy in blackboard. this endpoint is used to modify a user's relationship or details within a particular organizational unit, such as a department, school, or other institutional division. it allows for the management of user data in the context of the institution's structure, enabling administrators to keep user information accurate and up-to-date within the hierarchy. this tool should be used when there's a need to change a user's status, role, or other attributes specific to their position within a certain part of the institution. it's particularly useful for large educational organizations with complex hierarchical structures.
Update User Observer
Updates the observer relationship between a user and an observer in the blackboard learn platform. this endpoint is used to modify existing observer connections, such as changing the level of access or updating the relationship status between a student and a parent/guardian. it should be used when there's a need to adjust the monitoring permissions or details of an established observer relationship. the endpoint doesn't create new observer relationships; it only modifies existing ones. note that this operation may have implications on privacy settings and data access within the blackboard environment.
Create New Lti Placement
Creates 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 Details
Creates 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 Question
This 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 Details
Creates 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 Course
Creates 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 Course
Creates 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 Content
Creates 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 Description
Creates 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 Profile
Creates 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 Rule
Removes 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 Criterion
Deletes 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 Meetings
Deletes 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 User From Course Meetings
This endpoint removes a user from a meeting within a specific course in the blackboard learning management system. it should be used when an administrator or instructor needs to revoke a user's access to a particular course meeting, such as when a student drops a course or a teaching assistant's role changes. the operation is permanent and cannot be undone through this api, so it should be used with caution. this endpoint does not provide any information about the success of the operation or the current state of the meeting after the deletion.
Delete Course Meeting
Deletes 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 Meeting
Deletes 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 Id
Deletes 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 File
Deletes 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 Record
Delete 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 Id
This endpoint deletes a specific calendar item from the blackboard learn system. it allows users to remove events from personal, course, organization, or institution calendars. the endpoint should be used when a calendar item needs to be permanently removed from the system, such as canceling an event or correcting erroneously created entries. it's important to note that this operation is irreversible, and once an item is deleted, it cannot be recovered through the api. users should exercise caution when invoking this endpoint to avoid unintentional loss of calendar data. the endpoint requires precise identification of the calendar item through its type and unique id, ensuring accurate removal of the intended event.
Delete Category By Type And Id
This 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 Id
Deletes a specific content item from a course in the blackboard learning management system. this endpoint should be used when an administrator or authorized user needs to remove outdated, incorrect, or unnecessary learning materials from a course. it permanently removes the specified content, so it should be used with caution. this operation cannot be undone, and once content is deleted, it cannot be recovered through the api. the endpoint requires both a valid course id and content id to function correctly.
Delete Course Content Group By Id
This 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 Id
Deletes a specific course from the blackboard learning management system. this endpoint permanently removes all course data, including content, assignments, and student records associated with the specified course. it should be used with caution, typically at the end of an academic term or when a course is no longer needed. once a course is deleted, it cannot be recovered through the api. this operation is irreversible and should only be performed by users with appropriate permissions, such as system administrators or course managers.
Delete Course Meeting
This 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 Id
Deletes 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 Id
Deletes 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 Attachment
Deletes 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 Id
Deletes 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 Id
Deletes 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 Id
Deletes 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 Ids
This 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 Group
Removes 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 Rule
Removes 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 Course
This 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 List
Removes 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 Id
This 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 Nodeid
Deletes 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 Admin
Removes 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 Node
Removes 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 Node
This 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 Observer
This 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 Id
This 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 Id
Deletes a specific pronoun setting from the blackboard learning management system. this endpoint is used to remove a user's pronoun preference from the system, identified by a unique pronounid. it should be used when a pronoun setting is no longer needed, such as when a user wants to change their pronoun preference or when an administrator needs to remove an incorrect or outdated setting. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this endpoint only deletes the pronoun setting and does not affect any other user data or settings in the system.
Delete Course Assessment Question
Deletes 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 Rubric
Deletes a specific rubric associated with a given course in the blackboard learn system. this endpoint should be used when an instructor or administrator needs to permanently remove a rubric from a course, such as when the rubric is no longer relevant or has been replaced. the operation is irreversible, so caution should be exercised before deletion. this endpoint does not return the deleted rubric data; it only performs the deletion operation. it's important to note that deleting a rubric may impact any assignments or assessments that were using it, so those should be updated accordingly after deletion.
Delete Rubric Association
Deletes a specific rubric association within a course in the blackboard learn platform. this endpoint removes the link between a rubric and its associated item (such as an assignment or assessment) in a given course. it should be used when an instructor or administrator needs to disassociate a rubric from a particular course item, perhaps due to changes in assessment criteria or course structure. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return any content upon successful deletion, indicating that the association has been removed from the system.