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 smalle…
nameRequiredstringThe title of the group.
fieldsstringA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
courseIdRequiredstringThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 |…
parentIdstringThe primary ID of the group"s parent group set.
externalIdstringAn externally-defined unique ID for the group. Defaults to a random UUID if not provided during create.
isGroupSetbooleanWhether or not this is a group set. **Since**: 3700.1.0
descriptionstringThe description of the group. 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.
enrollment__typestringWhether the Group allows self enrollment or only enrolled by instructor. This can only be set on creation. | Type | Description | --------- | --------- | | InstructorOnly | Students are added to the Group by the instructor | | SelfEnrollment | Students are added to the Group by…
enrollment__limitintegerThe maximum allowed enrollment size for self enrolled groups.
availability__availablestringWhether the Group is currently available to students. | Type | Description | --------- | --------- | | Yes | Students may access the group. | | No | Students may not access the group. | | SignupOnly | Students may only signup and see the group listed, not yet access it. |
enrollment__signupSheet__namestringThe name of the signup sheet
enrollment__signupSheet__descriptionstringThe description of the signup sheet 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.
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.