Skip to main content
D2L Brightspace logo
  • Category: education
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 45
  • Triggers: 0
  • Slug: D2LBRIGHTSPACE
  • Version: 20261101_00

Tools

Slug: D2LBRIGHTSPACE_COPY_ROLECreates a new role copied from an existing role in D2L Brightspace. Notes: - The new role will not have any capabilities upon the old role from which it was created - Some capabilities will be copied for the new role (e.g., if old role users could impersonate other old role users, new role users will be able to impersonate other new role users) - Additional capabilities must be manually created after copying Requires OAuth2 scope: - role:detail:create Available in API versions unstable (LMS v10.4.10+)

Input Parameters

object
required
Properties for the new role
integer
required
Source role ID to act as template for new role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_CREATE_A_COURSE_OFFERINGCreates a new course offering in D2L Brightspace. Notes: - Course code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - Path: leave empty if path enforcement is enabled - SemesterId: provide null if not using the Semester element - CanSelfRegister: required for API v1.28+, not supported before v1.28 Requires OAuth2 scope: - orgunits:course:create Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

object
required
Data for creating the new course offering

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_CREATE_A_COURSE_TEMPLATECreates a new course template in D2L Brightspace. Notes: - Course template code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - Path: leave empty if path enforcement is enabled Requires OAuth2 scope: - orgunits:coursetemplate:create Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

object
required
Data for creating the new course template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_CREATE_GRADE_OBJECTCreates a new grade object for a particular org unit. The grade object can be one of four types: 1. Numeric: For numeric grades with max points 2. PassFail: For pass/fail assessments 3. SelectBox: For predefined grade options 4. Text: For text-only feedback Returns a GradeObject JSON block containing the created grade object’s data, including its assigned ID. Requires OAuth2 scope: - grades:gradeobjects:write Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit to create the grade object in
object
required
Grade object data. Must be one of these types: - Numeric: Includes MaxPoints, CanExceedMaxPoints, etc. - PassFail: Includes MaxPoints, IsBonus, etc. - SelectBox: Includes MaxPoints, IsBonus, GradeSchemeId (required), etc. - Text: Basic grade object with Name, ShortName, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_CREATE_QUIZCreates a new quiz in D2L Brightspace. Notes: - NumberOfAttemptsAllowed must be between 1 and 10 (inclusive) or null for unlimited - Password must not be empty or whitespace if provided - NotificationEmail must be a valid email address if provided - TimeLimitValue: 0 for no limit (with IsEnforced false), or 1-9999 for enforced limit - DeductionPercentage must be between 0 and 100 if provided - As of LE API v1.71: - LateLimitMinutes is ignored - LateSubmissionOption 1 is treated as 2 (AutoSubmitAttempt) - SubmissionGracePeriod is not used - PagingTypeId added in LE API v1.78 - Date fields should be in UTC format Requires OAuth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

object
required
Quiz creation data
integer
required
ID of the org unit to create the quiz in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_CREATE_QUIZ_CATEGORYCreates a new quiz category in D2L Brightspace. Returns a QuizCategoryReadData JSON block containing: - CategoryId: The ID of the created category - Name: The name of the category - SortOrder: The sort order value Requires OAuth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit to create the quiz category in
object
required
Quiz category creation data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_CREATE_USERCreates a new user entity in D2L Brightspace. Requires OAuth2 scope: - users:userdata:create Available in API versions 1.46+ (LMS v20.24.3+) Notes: - FirstName and LastName are used as legal names - ExternalEmail must be null or a valid email address - OrgDefinedId must be unique across the organization if provided - Preferred names must be set separately after user creation

Input Parameters

object
required
Data for creating the new user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_A_COURSE_TEMPLATEDeletes a course template from D2L Brightspace. Requires OAuth2 scope: - orgunits:course:delete Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

integer
required
ID of the course template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_COURSEDeletes a course offering from D2L Brightspace. Requires OAuth2 scope: - orgunits:course:delete Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

string
required
ID of the course offering to delete. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_GRADE_OBJECTDeletes a specific grade object from an org unit. Requires OAuth2 scope: - grades:gradeobjects:delete Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit containing the grade object
integer
required
ID of the grade object to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_QUIZDeletes a quiz from D2L Brightspace. Requires OAuth2 scope: - quizzing:quizzes:delete Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the quiz to delete
integer
required
ID of the org unit containing the quiz

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_QUIZ_CATEGORYDeletes a quiz category from D2L Brightspace. Requires OAuth2 scope: - quizzing:quizzes:delete Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the quiz category to delete
integer
required
ID of the org unit containing the quiz category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_USERDeletes a user entity from D2L Brightspace. Requires OAuth2 scope: - users:userdata:delete Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

string
required
ID of the user to delete. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_DELETE_USER_DEMOGRAPHICSDeletes a user’s demographics entries: a nonempty list of entry IDs selects entries, while an omitted or empty list deletes all entries. Requires OAuth2 scope demographics:user:delete; available in API versions 1.46+ (LMS v20.24.3+).

Input Parameters

integer
required
ID of the user whose demographics to delete
array
Optional. Specific entry IDs to delete. If not provided, all entries will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_A_COURSE_OFFERINGRetrieves a specific course offering from D2L Brightspace. Returns a CourseOffering JSON block with the course’s information. Requires OAuth2 scope: - orgunits:course:read Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

string
required
ID of the course offering to retrieve. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_A_COURSE_TEMPLATERetrieves a course template from D2L Brightspace. Returns a CourseTemplate JSON block with the template’s information. Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

integer
required
ID of the course template to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_COURSE_SCHEMARetrieves the parent organizational unit type constraints for course offerings. Returns an array of schema elements describing the allowed parent types. Available in API versions 1.46 and later (LMS v20.24.3 and later).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_COURSE_TEMPLATE_SCHEMARetrieves course template parent organizational unit type constraints as an array of schema elements. Available in API versions 1.46+ (LMS v20.24.3+).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_CURRENT_USERRetrieves the current user context’s user information from D2L Brightspace. Requires one of these OAuth2 scopes: - users:profile:read - users:own_profile:read Available in API versions 1.46+ (LMS v20.24.3+)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_ENROLLED_ROLESRetrieves a list of all enrolled user roles the calling user can view in an org unit. Returns a JSON array of Role data blocks containing the properties of all user roles that the calling user context has permission to view and that are currently enrolled in the provided org unit. Requires OAuth2 scope: - role:detail:read Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

integer
required
ID of the org unit to get enrolled roles from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_GRADE_ACCESSRetrieves a list of users with access to a specified grade. Returns an ObjectListPage containing UserAccess blocks. Can optionally filter by specific user ID or role ID. Requires OAuth2 scope: - grades:access:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
Optional. Get access for users with this role
integer
Optional. Get access for a specific user
integer
required
ID of the org unit containing the grade
string
required
ID of the grade object to get access for. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_GRADE_OBJECTRetrieves a specific grade object for a particular org unit. Returns a GradeObject JSON block containing the grade object’s properties. Requires OAuth2 scope: - grades:gradeobjects:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit containing the grade object
integer
required
ID of the grade object to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_GRADE_OBJECTSRetrieves all current grade objects for a particular org unit. Returns an array of grade objects. Requires OAuth2 scope: - grades:gradeobjects:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit to get grade objects from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_GRADE_SETUPRetrieves the grades configuration for an org unit. Returns a GradeSetupInfo JSON block containing the grades setup information. Requires OAuth2 scope: - grades:gradesettings:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit to get grades configuration from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_GRADE_STATISTICSRetrieves statistics for a specified grade item. Returns a GradeStatisticsInfo JSON block containing statistical data about the grade item. Requires OAuth2 scope: - grades:gradestatistics:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

string
required
ID of the org unit containing the grade (string to preserve precision for 64-bit D2LIDs).
string
required
ID of the grade object to get statistics for (string to preserve precision for 64-bit D2LIDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_ORG_UNIT_DEMOGRAPHICSRetrieves all demographics entries for users enrolled in a particular org unit. Notes: - Filters are applied cumulatively (all conditions must match) - When using ID lists in filters, matching any ID in the list satisfies that filter - For example: with roleIds=[1,2], userIds=[3,4], search=“value”: * Users must have role 1 OR 2 (either role matches) * AND must have ID 3 OR 4 (either ID matches) * AND must have a field matching “value” - Results are paged; use bookmark parameter for subsequent pages Requires OAuth2 scope: - demographics:orgunit:read Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

Optional. Search string to look for in the demographic field values
string
Optional. Bookmark to use for fetching the next data set segment
array
Optional. List of user role IDs to filter by
array
Optional. List of user IDs to filter by
array
Optional. List of demographic field IDs to filter by
string
required
ID of the org unit to get demographics from (string to preserve precision for 64-bit D2LIDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZRetrieves a specific quiz from an org unit. Returns a QuizReadData JSON block containing the quiz’s properties. Requires OAuth2 scope: - quizzing:quizzes:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

string
required
ID of the quiz to retrieve. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.
integer
required
ID of the org unit containing the quiz

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZ_ACCESSRetrieves a list of users with access to a specified quiz. Returns an ObjectListPage JSON block containing a list of UserAccess blocks. Can filter by specific user ID or role ID. Requires OAuth2 scope: - quizzing:access:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

string
required
ID of the quiz to get access information for (string to preserve precision for 64-bit D2LIDs).
integer
Optional. Get access for users with this role
integer
Optional. Get access for a specific user
string
required
ID of the org unit containing the quiz (string to preserve precision for 64-bit D2LIDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZ_ATTEMPTRetrieves a specific quiz attempt. Returns a QuizAttemptData JSON block containing the attempt’s properties. Requires OAuth2 scope: - quizzing:attempts:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the quiz
integer
required
ID of the attempt to retrieve
string
required
ID of the org unit containing the quiz. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZ_ATTEMPTSRetrieves a page of quiz attempts, optionally filtered by user, in a result field. Requires OAuth2 scope quizzing:attempts:read; available in API versions 1.75+ (LMS v20.24.5+).

Input Parameters

string
required
ID of the quiz to get attempts for (string to preserve precision for 64-bit D2LIDs).
integer
Optional. Get attempts for a specific user
string
required
ID of the org unit containing the quiz (string to preserve precision for 64-bit D2LIDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZ_CATEGORIESRetrieves all quiz categories belonging to an org unit. Returns an ObjectListPage JSON block containing a list of QuizCategoryReadData blocks. Requires OAuth2 scope: - quizzing:quizzes:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

string
required
ID of the org unit to get quiz categories from (string to preserve precision for 64-bit D2LIDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZ_CATEGORYRetrieves a specific quiz category from an org unit. Returns a QuizCategoryReadData JSON block containing the category’s properties. Requires OAuth2 scope: - quizzing:quizzes:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the quiz category to retrieve
integer
required
ID of the org unit containing the quiz category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZ_QUESTIONSRetrieves a page of questions in a quiz as an ObjectListPage of QuestionData blocks; use the bookmark from the next-page URL to retrieve further pages. Requires OAuth2 scope quizzing:quizzes:read; available in API versions 1.75+ (LMS v20.24.5+).

Input Parameters

integer
required
ID of the quiz to get questions from
string
Bookmark for pagination. Extract from the Next URL of previous response.
string
required
ID of the org unit containing the quiz. Accepts a numeric string (e.g. ‘12345’) to avoid JS Number.MAX_SAFE_INTEGER (2^53) precision loss on D2LID values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_QUIZZESRetrieves all quizzes belonging to an org unit. Returns an ObjectListPage JSON block containing a list of QuizReadData blocks. Requires OAuth2 scope: - quizzing:quizzes:read Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit to get quizzes from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_ROLE_BY_IDRetrieves a particular user role from D2L Brightspace by its ID. Requires OAuth2 scope: - role:detail:read Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

integer
required
ID of the role to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_ROLESRetrieves a list of all known user roles in D2L Brightspace. Returns a list of Role data blocks containing the properties of all user roles that the calling user context has permission to manage. Requires OAuth2 scope: - role:detail:read Available in API versions 1.46+ (LMS v20.24.3+)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_USER_BY_IDRetrieves data for a particular user from D2L Brightspace. Requires OAuth2 scope: - users:userdata:read Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

string
required
The ID of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_GET_USERSRetrieves user data in a result field, optionally filtered by organization-defined ID, username, or external email, and accepts a bookmark for a subsequent segment. Requires OAuth2 scope users:userdata:read; available in API versions 1.46+ (LMS v20.24.3+).

Input Parameters

string
Optional. Bookmark to use for fetching next data set segment
string
Optional. User name to look for
string
Optional. Org-defined identifier to look for
string
Optional. External email address to look for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_A_COURSE_OFFERINGUpdates an existing course offering in D2L Brightspace. Notes: - Course code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - StartDate/EndDate: null values won’t overwrite existing dates - CanSelfRegister: required for API v1.27+, not supported before v1.27 - Description: ignored in API versions 1.25 and earlier Requires OAuth2 scope: - orgunits:course:update Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

object
required
Updated course offering properties
string
required
ID of the course offering to update (string to preserve precision for 64-bit D2LIDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_A_COURSE_TEMPLATEUpdates an existing course template in D2L Brightspace. Notes: - This action completely replaces the template’s data with the provided values - Course template code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & Available in API versions 1.46+ (LMS v20.24.3+)

Input Parameters

integer
required
ID of the course template to update
object
required
Updated course template properties

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_GRADE_OBJECTUpdates a specific grade object. The grade object can be one of four types: 1. Numeric: For numeric grades with max points 2. PassFail: For pass/fail assessments 3. SelectBox: For predefined grade options 4. Text: For text-only feedback Note: The provided data completely replaces the existing grade object’s data. Returns a GradeObject JSON block containing the updated grade object’s data. Requires OAuth2 scope: - grades:gradeobjects:write Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the org unit containing the grade object
object
required
Updated grade object data. Must be one of these types: - Numeric: Includes MaxPoints, CanExceedMaxPoints, etc. - PassFail: Includes MaxPoints, IsBonus, etc. - SelectBox: Includes MaxPoints, IsBonus, GradeSchemeId (required), etc. - Text: Basic grade object with Name, ShortName, etc. Common restrictions: - Do not provide Id field - CategoryId must be valid or 0 - Description must use RichTextInput format - MaxPoints (if applicable) must be between 0.01 and 9999999999 - Name must be unique in the gradebook - Name cannot contain: / ” * < > + = | , % - Name and ShortName must be ≤128 characters - Do not provide GradeSchemeUrl or Weight fields Note: All provided data will replace the existing grade object’s data.
integer
required
ID of the grade object to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_GRADE_SETUPUpdates the grades configuration for an org unit. Expects a GradeSetupInfo JSON block containing: - GradingSystem: The grading system type - IsNullGradeZero: Whether null grades should be treated as zero - DefaultGradeSchemeId: ID of the default grade scheme Returns the updated GradeSetupInfo JSON block. Requires OAuth2 scope: - grades:gradesettings:write Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

object
required
The new grades configuration data
integer
required
ID of the org unit to update grades configuration for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_QUIZUpdates an existing quiz in D2L Brightspace using supplied non-null properties. Requires OAuth2 scopes quizzing:quizzes:read and quizzing:quizzes:write; available in API versions 1.75+ (LMS v20.24.5+).

Input Parameters

integer
required
ID of the quiz to update
object
required
Updated quiz data
integer
required
ID of the org unit containing the quiz

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_QUIZ_CATEGORYUpdates an existing quiz category in D2L Brightspace. Returns a QuizCategoryReadData JSON block containing: - CategoryId: The ID of the category - Name: The name of the category - SortOrder: The sort order value Requires OAuth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write Available in API versions 1.75+ (LMS v20.24.5+)

Input Parameters

integer
required
ID of the quiz category to update
integer
required
ID of the org unit containing the quiz category
object
required
Updated quiz category data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: D2LBRIGHTSPACE_UPDATE_USERUpdates an existing user entity in D2L Brightspace. Requires OAuth2 scope: - users:userdata:update Available in API versions 1.46+ (LMS v20.24.3+) Notes: - FirstName and LastName update preferred names if set, otherwise update legal names - ExternalEmail must be null or a valid email address - OrgDefinedId must be unique across the organization if provided - Pronouns: use empty string ("") to reset, null to keep existing value

Input Parameters

string
required
ID of the user to update (string to preserve precision for 64-bit D2LIDs).
object
required
Updated data for the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not