Skip to main content
Server path: /blackboard-communication | Type: Application | PCID required: Yes

Tools

ToolDescription
blackboard_communication_delete_learn_api_public_announcements_by_announcementidDelete Announcement
blackboard_communication_delete_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemidDelete Calendar Item
blackboard_communication_get_learn_api_public_announcementsGet Announcements
blackboard_communication_get_learn_api_public_announcements_by_announcementidGet Announcement
blackboard_communication_get_learn_api_public_calendarsGet Calendars
blackboard_communication_get_learn_api_public_calendars_itemsGet Calendar Items
blackboard_communication_get_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemidGet Calendar Item
blackboard_communication_get_learn_api_public_courses_by_courseid_discussionsGet Discussions
blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionidGet Discussion
blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messagesGet Discussion Messages
blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages_by_messageid_repliesGet Message Replies
blackboard_communication_patch_learn_api_public_announcements_by_announcementidUpdate Announcement
blackboard_communication_patch_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemidUpdate Calendar Item
blackboard_communication_post_learn_api_public_announcementsCreate Announcement
blackboard_communication_post_learn_api_public_calendars_itemsCreate Calendar Item

blackboard_communication_delete_learn_api_public_announcements_by_announcementid

Delete Announcement Parameters:
ParameterTypeRequiredDefaultDescription
announcementIdstringYesAnnouncement Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_delete_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid

Delete Calendar Item Parameters:
ParameterTypeRequiredDefaultDescription
calendarItemTypestringYesCalendar Item Type
calendarItemIdstringYesCalendar Item Id
deleteSeriesbooleanNodelete the series calendar items or just one calendar item. true - delete the series, false - delete one calendar item. Defaults to false.

blackboard_communication_get_learn_api_public_announcements

Get Announcements Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_announcements_by_announcementid

Get Announcement Parameters:
ParameterTypeRequiredDefaultDescription
announcementIdstringYesAnnouncement Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_calendars

Get Calendars Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_calendars_items

Get Calendar Items Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringNoSpecifies only calendar items associated with ‘courseId’ are to be returned. Since: 3400.9.0
typestringNoSpecifies only calendar items with the given type. Since: 3400.9.0 | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | |
sincestringNoSpecifies only calendar items after the ‘since’ date (inclusive) are to be returned. Maximum of 16 weeks after the ‘since’ date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] Since: 3400.9.0
untilstringNoSpecifies only calendar items before the ‘until’ date (inclusive) are to be returned. Maximum of 16 weeks prior to the ‘until’ date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] Since: 3400.9.0
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
sortstringNoProperties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “title(desc),start” Supported fields are: - id - calendarId - title - start - end - modified Since: 3400.9.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid

Get Calendar Item Parameters:
ParameterTypeRequiredDefaultDescription
calendarItemTypestringYesCalendar Item Type
calendarItemIdstringYesCalendar Item Id

blackboard_communication_get_learn_api_public_courses_by_courseid_discussions

Get Discussions Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe 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 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
sortstringNoProperties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “title(desc),available” Supported fields are: - id - title - available - gradable - createdDate - modifiedDate - gradebookColumnId Since: 3900.19.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid

Get Discussion Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe 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 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
discussionIdstringYesDiscussion Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages

Get Discussion Messages Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe 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 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
discussionIdstringYesDiscussion Id
groupIdstringNoSearch for messages which are associated with this groupId. Since: 3900.19.0
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
sortstringNoProperties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “createdDate(desc),givenName” Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead Since: 3900.19.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages_by_messageid_replies

Get Message Replies Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe 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 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
discussionIdstringYesDiscussion Id
messageIdstringYesMessage Id
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
sortstringNoProperties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “createdDate(desc),givenName” Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead Since: 3900.19.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_communication_patch_learn_api_public_announcements_by_announcementid

Update Announcement Parameters:
ParameterTypeRequiredDefaultDescription
announcementIdstringYesAnnouncement Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling availability of the System Announcement.
bodystringNoThe message body of the System Announcement. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’&gt;here&lt;/a> for more information.
showAtLoginbooleanNoWhether this System Announcement should be displayed on the login page.
showInCoursesbooleanNoWhether this System Announcement should be displayed on courses.
titlestringNoThe title of this System Announcement.

blackboard_communication_patch_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid

Update Calendar Item Parameters:
ParameterTypeRequiredDefaultDescription
calendarItemTypestringYesCalendar Item Type
calendarItemIdstringYesCalendar Item Id
updateSeriesbooleanNoupdate the series calendar items or just one calendar item. true - update the entire series, false - update a single calendar item. Defaults to false. When updating an entire series the full recurrence object must be populated just as if creating a new calendar series. If updating a single calendar entry the recurrence must not be specified.
descriptionstringNoDescription of the calendar item.
disableResizingbooleanNoWhether resizing of the calendar item should NOT be allowed.
dynamicCalendarItemPropsobjectNoExtra calendar item properties if it is a GradebookColumn calendar item.
endstringNoEnd date of the calendar item either in the past if the calendar item is for an event that’s already end OR in the future if it’s for an event to end in the future. This is always set and should occur after the start date.
locationstringNoLocation of the calendar item and it cannot exceed 1024 characters.
recurrenceobjectNoThe recurrence value
startstringNoStart date of the calendar item either in the past if the calendar item is for an event that’s already started OR in the future if it’s for an event to start in the future. This is always set and should occur before the end date.
titlestringNoTitle of the calendar item. Title length cannot exceed 255 characters.

blackboard_communication_post_learn_api_public_announcements

Create Announcement Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling availability of the System Announcement.
bodystringNoThe message body of the System Announcement. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’&gt;here&lt;/a> for more information.
showAtLoginbooleanNoWhether this System Announcement should be displayed on the login page.
showInCoursesbooleanNoWhether this System Announcement should be displayed on courses.
titlestringYesThe title of this System Announcement.

blackboard_communication_post_learn_api_public_calendars_items

Create Calendar Item Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
calendarIdstringYesCalendar source identifier which indicates the calendar on which the calendar item was created. Examples of possible values : “PERSONAL”, “INSTITUTION”, and course id in the format of “_3_1”.
descriptionstringNoDescription of the calendar item.
disableResizingbooleanNoWhether resizing of the calendar item should NOT be allowed.
dynamicCalendarItemPropsobjectNoExtra calendar item properties if it is a GradebookColumn calendar item.
endstringNoEnd date of the calendar item either in the past if the calendar item is for an event that’s already end OR in the future if it’s for an event to end in the future. This is always set and should occur after the start date.
locationstringNoLocation of the calendar item and it cannot exceed 1024 characters.
recurrenceobjectNoThe recurrence value
startstringNoStart date of the calendar item either in the past if the calendar item is for an event that’s already started OR in the future if it’s for an event to start in the future. This is always set and should occur before the end date.
titlestringNoTitle of the calendar item. Title length cannot exceed 255 characters.
typestringYesThe type of this Calendar Item. | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | |