> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# blackboard-groups
> Blackboard Groups - course groups, group users, memberships, and messages
**Server path:** `/blackboard-groups` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| [`blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid) | Delete Group |
| [`blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid) | Delete Group Membership |
| [`blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_sets_by_groupid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_sets_by_groupid) | Delete Group Set |
| [`blackboard_groups_delete_learn_api_public_courses_by_courseid_messages_by_messageid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_messages_by_messageid) | Delete Message |
| [`blackboard_groups_delete_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_users_by_userid) | Delete Membership |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups) | Get Groups |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid) | Get Group |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users) | Get Group Memberships |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid) | Get Group Membership |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets) | Get Group Sets |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid) | Get Group Set |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups) | Get Group Set Children |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_messages`](#blackboard_groups_get_learn_api_public_courses_by_courseid_messages) | Get Messages |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_messages_by_messageid_participants`](#blackboard_groups_get_learn_api_public_courses_by_courseid_messages_by_messageid_participants) | Get Message Participants |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_messages_folders`](#blackboard_groups_get_learn_api_public_courses_by_courseid_messages_folders) | Get Folders |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_users`](#blackboard_groups_get_learn_api_public_courses_by_courseid_users) | Get Course Memberships |
| [`blackboard_groups_get_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_users_by_userid) | Get Membership |
| [`blackboard_groups_get_learn_api_public_users_by_userid_courses`](#blackboard_groups_get_learn_api_public_users_by_userid_courses) | Get User Memberships |
| [`blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_by_groupid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_by_groupid) | Update Group |
| [`blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_sets_by_groupid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_sets_by_groupid) | Update Group Set |
| [`blackboard_groups_patch_learn_api_public_courses_by_courseid_messages_by_messageid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_messages_by_messageid) | Update Message |
| [`blackboard_groups_patch_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_users_by_userid) | Update Membership |
| [`blackboard_groups_post_learn_api_public_courses_by_courseid_groups`](#blackboard_groups_post_learn_api_public_courses_by_courseid_groups) | Create Group |
| [`blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets`](#blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets) | Create Group Set |
| [`blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups`](#blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups) | Create Group Set Child |
| [`blackboard_groups_post_learn_api_public_courses_by_courseid_messages`](#blackboard_groups_post_learn_api_public_courses_by_courseid_messages) | Create Message |
| [`blackboard_groups_put_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid`](#blackboard_groups_put_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid) | Create Group Membership |
| [`blackboard_groups_put_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_put_learn_api_public_courses_by_courseid_users_by_userid) | Create Membership |
***
## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid
Delete Group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `courseId` | string | Yes | — | The 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 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"courseId": {
"type": "string",
"description": "The 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 |"
}
},
"required": [
"PCID",
"groupId",
"courseId"
]
}
```
***
## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users\_by\_userid
Delete Group Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
}
},
"required": [
"PCID",
"courseId",
"groupId",
"userId"
]
}
```
***
## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid
Delete Group Set
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
}
},
"required": [
"PCID",
"courseId",
"groupId"
]
}
```
***
## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_messages\_by\_messageid
Delete Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `messageId` | string | Yes | — | Message Id |
| `folderType` | string | No | — | Specifies the folder type, The default type is inbox \| Type \| Description \| --------- \| --------- \| \| Inbox \| \| \| Sent \| \| \| Delete \| \| \| Custom \| \| |
| `folderName` | string | No | — | Specifies the folder name of the custom folder |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"messageId": {
"type": "string",
"description": "Message Id"
},
"folderType": {
"type": "string",
"description": "Specifies the folder type, The default type is inbox | Type | Description | --------- | --------- | | Inbox | | | Sent | | | Delete | | | Custom | |",
"enum": [
"Inbox",
"Sent",
"Delete",
"Custom"
]
},
"folderName": {
"type": "string",
"description": "Specifies the folder name of the custom folder"
}
},
"required": [
"PCID",
"courseId",
"messageId"
]
}
```
***
## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid
Delete Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups
Get Groups
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `name` | string | No | — | The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0 |
| `nameCompare` | string | No | — | Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 \| Type \| Description \| --------- \| --------- \| \| equals \| \| \| notEquals \| \| \| contains \| \| \| notContains \| \| \| startsWith \| \| |
| `inGroupSet` | boolean | No | — | Indicates whether only groups in a GroupSet (or groups NOT in a GroupSet) should be included **Since**: 3900.10.0 |
| `created` | string | No | — | Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0 |
| `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `modified` | string | No | — | Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0 |
| `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `sort` | string | No | — | Properties 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. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"name": {
"type": "string",
"description": "The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0"
},
"nameCompare": {
"type": "string",
"description": "Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |",
"enum": [
"equals",
"notEquals",
"contains",
"notContains",
"startsWith"
]
},
"inGroupSet": {
"type": "boolean",
"description": "Indicates whether only groups in a GroupSet (or groups NOT in a GroupSet) should be included **Since**: 3900.10.0"
},
"created": {
"type": "string",
"description": "Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"sort": {
"type": "string",
"description": "Properties 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. \"name(desc)\" Supported fields are: - name - externalId **Since**: 3100.4.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid
Get Group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"groupId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users
Get Group Memberships
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `courseId` | string | Yes | — | The 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 \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"groupId",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users\_by\_userid
Get Group Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"groupId",
"userId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets
Get Group Sets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `name` | string | No | — | The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0 |
| `nameCompare` | string | No | — | Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 \| Type \| Description \| --------- \| --------- \| \| equals \| \| \| notEquals \| \| \| contains \| \| \| notContains \| \| \| startsWith \| \| |
| `created` | string | No | — | Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0 |
| `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `modified` | string | No | — | Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0 |
| `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `sort` | string | No | — | Properties 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. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"name": {
"type": "string",
"description": "The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0"
},
"nameCompare": {
"type": "string",
"description": "Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |",
"enum": [
"equals",
"notEquals",
"contains",
"notContains",
"startsWith"
]
},
"created": {
"type": "string",
"description": "Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"sort": {
"type": "string",
"description": "Properties 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. \"name(desc)\" Supported fields are: - name - externalId **Since**: 3100.4.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid
Get Group Set
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"groupId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid\_groups
Get Group Set Children
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `name` | string | No | — | The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0 |
| `nameCompare` | string | No | — | Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 \| Type \| Description \| --------- \| --------- \| \| equals \| \| \| notEquals \| \| \| contains \| \| \| notContains \| \| \| startsWith \| \| |
| `created` | string | No | — | Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0 |
| `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `modified` | string | No | — | Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0 |
| `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `sort` | string | No | — | Properties 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. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0 |
| `courseId` | string | Yes | — | The 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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"name": {
"type": "string",
"description": "The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0"
},
"nameCompare": {
"type": "string",
"description": "Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |",
"enum": [
"equals",
"notEquals",
"contains",
"notContains",
"startsWith"
]
},
"created": {
"type": "string",
"description": "Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"sort": {
"type": "string",
"description": "Properties 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. \"name(desc)\" Supported fields are: - name - externalId **Since**: 3100.4.0"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"groupId",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_messages
Get Messages
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `folderType` | string | No | — | Specifies the folder type, The default type is inbox \| Type \| Description \| --------- \| --------- \| \| Inbox \| \| \| Sent \| \| \| Delete \| \| \| Custom \| \| |
| `folderName` | string | No | — | Specifies the folder name of the custom folder |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `sort` | string | No | — | Properties 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. "isRead(desc),start" Supported fields are: - isRead - postedDate **Since**: 3900.2.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"folderType": {
"type": "string",
"description": "Specifies the folder type, The default type is inbox | Type | Description | --------- | --------- | | Inbox | | | Sent | | | Delete | | | Custom | |",
"enum": [
"Inbox",
"Sent",
"Delete",
"Custom"
]
},
"folderName": {
"type": "string",
"description": "Specifies the folder name of the custom folder"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"sort": {
"type": "string",
"description": "Properties 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. \"isRead(desc),start\" Supported fields are: - isRead - postedDate **Since**: 3900.2.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_messages\_by\_messageid\_participants
Get Message Participants
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `messageId` | string | Yes | — | Message Id |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `participationType` | string | No | — | Search the participation type **Since**: 3800.20.0 |
| `sort` | string | No | — | Properties 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. "PARTICIPATION\_TYPE(desc),start" Supported fields are: - participationType **Since**: 3900.2.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"messageId": {
"type": "string",
"description": "Message Id"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"participationType": {
"type": "string",
"description": "Search the participation type **Since**: 3800.20.0"
},
"sort": {
"type": "string",
"description": "Properties 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. \"PARTICIPATION_TYPE(desc),start\" Supported fields are: - participationType **Since**: 3900.2.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"courseId",
"messageId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_messages\_folders
Get Folders
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_users
Get Course Memberships
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `role` | string | No | — | Search for memberships with a course role id that matches this value. **Since**: 3500.5.0 |
| `created` | string | No | — | Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0 |
| `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `modified` | string | No | — | Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0 |
| `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `dataSourceId` | string | No | — | Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax "externalId:math101". **Since**: 3100.0.0 |
| `lastAccessed` | string | No | — | Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0 |
| `lastAccessedCompare` | string | No | — | Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| \| Disabled \| **Since**: 3100.0.0 \| |
| `sort` | string | No | — | Properties 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. "created(desc)" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"role": {
"type": "string",
"description": "Search for memberships with a course role id that matches this value. **Since**: 3500.5.0"
},
"created": {
"type": "string",
"description": "Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"dataSourceId": {
"type": "string",
"description": "Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3100.0.0"
},
"lastAccessed": {
"type": "string",
"description": "Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0"
},
"lastAccessedCompare": {
"type": "string",
"description": "Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"availability.available": {
"type": "string",
"description": "Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |",
"enum": [
"Yes",
"No",
"Disabled"
]
},
"sort": {
"type": "string",
"description": "Properties 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. \"created(desc)\" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid
Get Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
```
***
## blackboard\_groups\_get\_learn\_api\_public\_users\_by\_userid\_courses
Get User Memberships
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
| `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
| `role` | string | No | — | Search for memberships with a course role id that matches this value. **Since**: 3500.5.0 |
| `created` | string | No | — | Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0 |
| `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `modified` | string | No | — | Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0 |
| `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `dataSourceId` | string | No | — | Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax "externalId:math101". **Since**: 3100.0.0 |
| `lastAccessed` | string | No | — | Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0 |
| `lastAccessedCompare` | string | No | — | Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| |
| `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| \| Disabled \| **Since**: 3100.0.0 \| |
| `sort` | string | No | — | Properties 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. "created(desc)" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"role": {
"type": "string",
"description": "Search for memberships with a course role id that matches this value. **Since**: 3500.5.0"
},
"created": {
"type": "string",
"description": "Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"dataSourceId": {
"type": "string",
"description": "Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3100.0.0"
},
"lastAccessed": {
"type": "string",
"description": "Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0"
},
"lastAccessedCompare": {
"type": "string",
"description": "Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"availability.available": {
"type": "string",
"description": "Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |",
"enum": [
"Yes",
"No",
"Disabled"
]
},
"sort": {
"type": "string",
"description": "Properties 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. \"created(desc)\" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid
Update Group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | Settings controlling availability of the group to students. |
| `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. |
| `enrollment` | object | No | — | Settings controlling enrollment of the group to students. |
| `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. |
| `name` | string | No | — | The title of the group. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the group to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether 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. |",
"enum": [
"Yes",
"No",
"SignupOnly"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the group. This field supports BbML; see here for more information."
},
"enrollment": {
"type": "object",
"description": "Settings controlling enrollment of the group to students.",
"properties": {
"limit": {
"type": "integer",
"description": "The maximum allowed enrollment size for self enrolled groups."
},
"signupSheet": {
"type": "object",
"description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create."
},
"name": {
"type": "string",
"description": "The title of the group."
}
},
"required": [
"PCID",
"courseId",
"groupId"
]
}
```
***
## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid
Update Group Set
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `courseId` | string | Yes | — | The 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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | Settings controlling availability of the group to students. |
| `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. |
| `enrollment` | object | No | — | Settings controlling enrollment of the group to students. |
| `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. |
| `name` | string | No | — | The title of the group. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the group to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether 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. |",
"enum": [
"Yes",
"No",
"SignupOnly"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the group. This field supports BbML; see here for more information."
},
"enrollment": {
"type": "object",
"description": "Settings controlling enrollment of the group to students.",
"properties": {
"limit": {
"type": "integer",
"description": "The maximum allowed enrollment size for self enrolled groups."
},
"signupSheet": {
"type": "object",
"description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create."
},
"name": {
"type": "string",
"description": "The title of the group."
}
},
"required": [
"PCID",
"groupId",
"courseId"
]
}
```
***
## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_messages\_by\_messageid
Update Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `messageId` | string | Yes | — | Message Id |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `isRead` | boolean | No | — | Whether or not the message has been read |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"messageId": {
"type": "string",
"description": "Message Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"isRead": {
"type": "boolean",
"description": "Whether or not the message has been read"
}
},
"required": [
"PCID",
"courseId",
"messageId"
]
}
```
***
## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid
Update Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `courseId` | string | Yes | — | The 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 \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | The availability value |
| `childCourseId` | string | No | — | The primary ID of the child, cross-listed course, in which the user is directly enrolled. \ This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable. \ If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to "null" will move the membership to the parent course. **Since**: 3000.11.0 |
| `courseRoleId` | string | No | — | The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. \| Type \| Description \| --------- \| --------- \| \| Instructor \| Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. \| \| BbFacilitator \| The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. \| \| TeachingAssistant \| The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. \| \| CourseBuilder \| Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. \| \| Grader \| Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. \| \| Student \| \| \| Guest \| Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. \| |
| `dataSourceId` | string | No | — | The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax "externalId:math101". |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "The availability value",
"properties": {
"available": {
"type": "string",
"description": "null | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |",
"enum": [
"Yes",
"No",
"Disabled"
]
}
}
},
"childCourseId": {
"type": "string",
"description": "The primary ID of the child, cross-listed course, in which the user is directly enrolled. This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable. If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to \"null\" will move the membership to the parent course. **Since**: 3000.11.0"
},
"courseRoleId": {
"type": "string",
"description": "The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. | Type | Description | --------- | --------- | | Instructor | Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. | | BbFacilitator | The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. | | TeachingAssistant | The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. | | CourseBuilder | Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. | | Grader | Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. | | Student | | | Guest | Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. |",
"enum": [
"Instructor",
"BbFacilitator",
"TeachingAssistant",
"CourseBuilder",
"Grader",
"Student",
"Guest"
]
},
"dataSourceId": {
"type": "string",
"description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"."
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
```
***
## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_groups
Create Group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | Settings controlling availability of the group to students. |
| `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. |
| `enrollment` | object | No | — | Settings controlling enrollment of the group to students. |
| `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. |
| `name` | string | Yes | — | The title of the group. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the group to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether 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. |",
"enum": [
"Yes",
"No",
"SignupOnly"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the group. This field supports BbML; see here for more information."
},
"enrollment": {
"type": "object",
"description": "Settings controlling enrollment of the group to students.",
"properties": {
"type": {
"type": "string",
"description": "Whether 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 self enrollment |",
"enum": [
"InstructorOnly",
"SelfEnrollment"
]
},
"limit": {
"type": "integer",
"description": "The maximum allowed enrollment size for self enrolled groups."
},
"signupSheet": {
"type": "object",
"description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create."
},
"name": {
"type": "string",
"description": "The title of the group."
}
},
"required": [
"PCID",
"courseId",
"name"
]
}
```
***
## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets
Create Group Set
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | Settings controlling availability of the group to students. |
| `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. |
| `enrollment` | object | No | — | Settings controlling enrollment of the group to students. |
| `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. |
| `name` | string | Yes | — | The title of the group. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the group to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether 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. |",
"enum": [
"Yes",
"No",
"SignupOnly"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the group. This field supports BbML; see here for more information."
},
"enrollment": {
"type": "object",
"description": "Settings controlling enrollment of the group to students.",
"properties": {
"type": {
"type": "string",
"description": "Whether 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 self enrollment |",
"enum": [
"InstructorOnly",
"SelfEnrollment"
]
},
"limit": {
"type": "integer",
"description": "The maximum allowed enrollment size for self enrolled groups."
},
"signupSheet": {
"type": "object",
"description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create."
},
"name": {
"type": "string",
"description": "The title of the group."
}
},
"required": [
"PCID",
"courseId",
"name"
]
}
```
***
## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid\_groups
Create Group Set Child
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `courseId` | string | Yes | — | The 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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | Settings controlling availability of the group to students. |
| `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. |
| `enrollment` | object | No | — | Settings controlling enrollment of the group to students. |
| `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. |
| `name` | string | Yes | — | The title of the group. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the group to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether 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. |",
"enum": [
"Yes",
"No",
"SignupOnly"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the group. This field supports BbML; see here for more information."
},
"enrollment": {
"type": "object",
"description": "Settings controlling enrollment of the group to students.",
"properties": {
"type": {
"type": "string",
"description": "Whether 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 self enrollment |",
"enum": [
"InstructorOnly",
"SelfEnrollment"
]
},
"limit": {
"type": "integer",
"description": "The maximum allowed enrollment size for self enrolled groups."
},
"signupSheet": {
"type": "object",
"description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create."
},
"name": {
"type": "string",
"description": "The title of the group."
}
},
"required": [
"PCID",
"groupId",
"courseId",
"name"
]
}
```
***
## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_messages
Create Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `attachment` | object | No | — | The attachment value |
| `bccUsers` | string\[] | No | — | The bcc participants of the message |
| `body` | string | No | — | The body text of the message. This field supports BbML; see \ for more information. |
| `ccUsers` | string\[] | No | — | The cc participants of the message |
| `id` | string | No | — | The ID of the message |
| `isExistingAttachment` | boolean | No | — | Whether or not the attachment is the existing attachment for the message |
| `isRead` | boolean | No | — | Whether or not the message has been read |
| `isReply` | boolean | No | — | Whether or not this message is a reply to another message |
| `subject` | string | No | — | The subject of the message. |
| `toUsers` | string\[] | No | — | The to participants of the message |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"attachment": {
"type": "object",
"description": "The attachment value",
"properties": {
"id": {
"type": "string",
"description": "The ID of file attachment"
},
"fileName": {
"type": "string",
"description": "The fileName of the attachment"
},
"mimeType": {
"type": "string",
"description": "The mime type of the attachment"
},
"fileLocation": {
"type": "string",
"description": "The location of the uploaded file"
}
}
},
"bccUsers": {
"type": "array",
"items": {
"type": "string"
},
"description": "The bcc participants of the message"
},
"body": {
"type": "string",
"description": "The body text of the message. This field supports BbML; see here for more information."
},
"ccUsers": {
"type": "array",
"items": {
"type": "string"
},
"description": "The cc participants of the message"
},
"id": {
"type": "string",
"description": "The ID of the message"
},
"isExistingAttachment": {
"type": "boolean",
"description": "Whether or not the attachment is the existing attachment for the message"
},
"isRead": {
"type": "boolean",
"description": "Whether or not the message has been read"
},
"isReply": {
"type": "boolean",
"description": "Whether or not this message is a reply to another message"
},
"subject": {
"type": "string",
"description": "The subject of the message."
},
"toUsers": {
"type": "array",
"items": {
"type": "string"
},
"description": "The to participants of the message"
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_groups\_put\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users\_by\_userid
Create Group Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courseId` | string | Yes | — | The 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 \| |
| `groupId` | string | Yes | — | The group 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:breakfastClub \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"groupId": {
"type": "string",
"description": "The group 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:breakfastClub |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"groupId",
"userId"
]
}
```
***
## blackboard\_groups\_put\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid
Create Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `courseId` | string | Yes | — | The 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 \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | The availability value |
| `childCourseId` | string | No | — | The primary ID of the child, cross-listed course, in which the user is directly enrolled. \ This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable. \ If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to "null" will move the membership to the parent course. **Since**: 3000.11.0 |
| `courseRoleId` | string | No | — | The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. \| Type \| Description \| --------- \| --------- \| \| Instructor \| Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. \| \| BbFacilitator \| The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. \| \| TeachingAssistant \| The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. \| \| CourseBuilder \| Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. \| \| Grader \| Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. \| \| Student \| \| \| Guest \| Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. \| |
| `dataSourceId` | string | No | — | The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax "externalId:math101". |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "The availability value",
"properties": {
"available": {
"type": "string",
"description": "null | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |",
"enum": [
"Yes",
"No",
"Disabled"
]
}
}
},
"childCourseId": {
"type": "string",
"description": "The primary ID of the child, cross-listed course, in which the user is directly enrolled. This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable. If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to \"null\" will move the membership to the parent course. **Since**: 3000.11.0"
},
"courseRoleId": {
"type": "string",
"description": "The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. | Type | Description | --------- | --------- | | Instructor | Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. | | BbFacilitator | The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. | | TeachingAssistant | The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. | | CourseBuilder | Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. | | Grader | Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. | | Student | | | Guest | Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. |",
"enum": [
"Instructor",
"BbFacilitator",
"TeachingAssistant",
"CourseBuilder",
"Grader",
"Student",
"Guest"
]
},
"dataSourceId": {
"type": "string",
"description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"."
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
```