LTI Pro supports bulk disassociating meetings via API. These imported meetings can be disassociated(removed) from the LTI Pro courses via API if needed.
Note:
PUT /meeting/bulkDisassociate
--header 'X-Lti-Signature: H-nOALLKJOT5i56RRKE5ehCZk9A'
key=KLAIJC9OTI2Hm-vxn3UVHK×tamp=1634769623355
“key=KLAIJC9OTI2Hm-vxn3UVHK×tamp=1634769623355&userId=12dd589465Z=”
Note: The signature will be valid for 60 minutes.
Note: The below fields are required.
Parameter | Type | Description |
timestamp | String | Current timestamp when the request is created. The value is in milliseconds. |
key | String | Identifier of the LTI application that is making the request. LTI Key value can be found in LTI config page. |
Content-Type: application/json
[
{
"meetingId":"String",
"contextId":"String",
"courseId":"String",
"domain":"String"
},
{
"meetingId ":"String",
"contextId":"String",
"courseId":"String",
"domain":"String"
}
]
Content-Type: application/json
{
"userId": "String",
"meetingList":
[
{
"meetingId":"String"
"contextId":"String"
"courseId":"String"
"domain":"String"
},
{
"meetingId ":"String"
"contextId":"String"
"courseId":"String"
"domain":"String"
}
]
}
[
{
"meetingId": "0123456789",
"contextId": "sjaldjfjdkdlsj",
"courseId": "Sample CourseID",
"domain": "https://somelmsdomain.com"
}
]
Parameter | Type | Description |
meetingId* | String | The meeting ID of the meeting you are disassociating from a course. |
contextId* | String | The Context ID for the course that the meeting is associated with. |
domain* | String | The Domain used to access the LMS. |
courseId** | String | The courseId is only required to support Canvas Calendar and Conversations. |
userId*** | String | User Id of the Zoom user. This user needs to be an Admin role in order to run the API. |
meetingList*** | String | List of LTI Meeting Info |
*Note: This field is required.
**Note: This is only required in order to support Canvas Calendar and Conversations.
**Note: If a specific user is needed to create the calendar event within the LMS, the userId should be added to the request body. In addition, meetingList should be utilized as seen in the second request example above.
{
"type": "object",
"properties": {
"meetingId": {
"type": "string",
"description": "The meeting ID of the meeting you are disassociating from a course."
},
"contextId": {
"type": "string",
"description": "The Context ID for the course that the meeting is associated with."
},
"domain": {
"type": "string",
"description": "The Domain used to access the LMS."
},
"courseId": {
"type": "string",
"description": "The courseId is only required to support Canvas Calendar and Conversations."
}
},
"required": [
"meetingId",
"contextId",
"domain"
]
}
{
"status": true,
"result": "Processing Bulk Disassociate"
}
{
"status": false,
"errorCode": "401"
}