Updates 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…
namestringThe name of the term.
fieldsstringA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
termIdRequiredstringThe term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |
externalIdstringAn externally-defined unique ID for the term. Formerly known as "sourcedidId".
descriptionstringThe description of the term. This field supports BbML; see <a target="_blank" href="https://docs.anthology.com/docs/rest-apis/learn/advanced/bbml.html">here</a> for more information.
dataSourceIdstringThe ID of the data source associated with this term. This may optionally be the data source"s externalId using the syntax "externalId:math101".
availability__availablestringWhether the term and the courses it contains are available to students. Instructors can always access their courses. | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the…
availability__duration__endstringThe date this term ends. May only be set if availability.duration.type is DateRange.
availability__duration__typestringThe intended length of the term. Possible values are: | Type | Description | --------- | --------- | | Continuous | The term is active on an ongoing basis. This is the default. | | DateRange | The term will only be available between specific date ranges. | | FixedNumDays | The t…
availability__duration__startstringThe date this term starts. May only be set if availability.duration.type is DateRange.
availability__duration__daysOfUseintegerThe number of days courses within this term can be used. May only be set if availability.duration.type is FixedNumDays.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.