Cancel Workshop Occurrence
Cancel one creator-owned workshop occurrence, whether it is standalone or part of a recurring series. To cancel every currently eligible occurrence in a series, use Cancel Recurring Workshop Series. Send no body or cancellation reason.
Eligibility
- The occurrence must be a non-deleted workshop, not a consultation booking.
- Its status must be
upcomingorongoing, and its start must be at least 60 seconds away when eligibility is checked; exactly 60 seconds is eligible. - The 30-minute editing restriction does not apply to cancellation.
Result and side effects
- The retained occurrence is returned with
status: cancelledandisEditable: false; other occurrences in the series are not cancelled. - Renumbering of remaining non-cancelled siblings is attempted after cancellation; a refresh failure does not fail the request, so recurrence numbers can remain stale.
- Cleanup of any assigned Zoom session is attempted before the cancellation status is written.
- Cancellation emails, notifications, and automation webhooks are attempted asynchronously; a successful response does not guarantee delivery.
Errors and retries
Missing, foreign, deleted, already-cancelled, consultation, and too-late occurrences all return 400 WORKSHOP_CANCELLATION_NOT_ALLOWED with No videocalls found that can be cancelled. Repeating a completed cancellation returns the same error without new cancellation effects.
A malformed path ID returns the standard validation error with videoCallId must be a valid object id.
Cancellation is not atomic across workshop state, Zoom cleanup, and notifications. After a timeout or server error, read the occurrence before retrying; concurrent requests are not deduplicated.
External access policy
An API key and an authorized white-label host are required. Both tier and plan requirements are enforced.
These requirements apply to the white-label creator for backend-to-backend access. TagMango platform access is not supported.
-
Plans: Unrestricted.
-
Tiers: Unrestricted.
Authorization
bearer In: header
Path Parameters
The 24-character hexadecimal _id returned for an occurrence by Get Workshop Video Calls.
^[0-9a-fA-F]{24}$24 <= length <= 24Header Parameters
Host name of the dashboard, ex: mydomain.tagmango.com
Request-level UTC offset in minutes for cancellation messages. Omit it to send no request-level override. It does not affect cancellation eligibility.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://api-prod-new.tagmango.com/api/v1/external/workshops/video-calls/66c4964c11e7fef26751f3a6" \ -H "x-whitelabel-host: string"{
"_id": "66c4964c11e7fef26751f3a7",
"title": "Sunday Growth Workshop",
"description": "Plan the next growth campaign with practical examples.",
"thumbnail": "https://cdn.example.com/workshops/growth-workshop.jpg",
"fromTime": "2026-09-20T10:02:00.000Z",
"toTime": "2026-09-20T11:02:00.000Z",
"startDate": "2026-09-20",
"fromTime24h": "15:32",
"duration": 60,
"timezoneName": "Asia/Kolkata",
"timezone": "+05:30",
"status": "cancelled",
"isEditable": true,
"notEditableReason": "A call can only be edited up to 30 minutes before it starts",
"isScheduleLocked": false,
"platform": "tagmango",
"meetingUrl": "https://meet.google.com/abc-xyz",
"zoomMeetingType": "webinar",
"ongoingCallType": "webinar",
"zoomMeetingLink": "https://zoom.us/j/98765432101?pwd=abc123",
"zoomMeetingLinkCreator": "https://zoom.us/s/98765432101?zak=abc123",
"mango": [
{
"_id": "66a1390268a76f2f5c9f39a3",
"title": "Introduction to Coding"
}
],
"excludeMangoes": [
{
"_id": "66a1390268a76f2f5c9f39a3",
"title": "Introduction to Coding"
}
],
"mangoToSell": {
"_id": "66a1390268a76f2f5c9f39a3",
"title": "Introduction to Coding"
},
"zoomWaitingList": false,
"zoomRegistration": false,
"enableRecordingZoomCall": false,
"autoUploadRecordingsEnabled": false,
"autoUploadRecordingsConfig": [
{
"target": "course",
"courseId": "66c4964c11e7fef26751f3a9",
"courseTitle": "Advanced Marketing",
"sectionIds": [
"66c4964c11e7fef26751f3aa"
]
}
],
"recordings": [
{
"recordingType": "shared_screen_with_speaker_view",
"url": "https://cdn.example.com/recordings/abc.mp4",
"isZoomHostedUrl": false,
"recordingStartTime": "2026-09-20T10:02:00.000Z",
"recordingEndTime": "2026-09-20T11:02:00.000Z",
"fileSize": 148372221,
"fileExtension": "MP4"
}
],
"recordingReceivedAt": "2026-09-20T11:12:00.000Z",
"isRecordingDeleted": false,
"recordingDeletedAt": "2026-12-20T00:00:00.000Z",
"callType": "recurring",
"groupId": "66c4964c11e7fef26751f3a6",
"occurrence": 2,
"totalOccurrence": 8,
"showGroupLinkForRecurringCall": false,
"participantCount": 42,
"videoCallRescheduledAt": "2026-09-10T09:00:00.000Z",
"createdAt": "2026-09-01T09:00:00.000Z"
}{
"code": 400,
"type": "Bad Request",
"statusMessage": "BAD_REQUEST",
"errorCode": "WORKSHOP_CANCELLATION_NOT_ALLOWED",
"message": "No videocalls found that can be cancelled",
"result": "No videocalls found that can be cancelled",
"success": false
}{
"code": 401,
"type": "Unauthorized",
"statusMessage": "UNAUTHORIZED",
"message": "Invalid token",
"result": "Invalid token",
"success": false
}{
"code": 403,
"type": "Forbidden",
"statusMessage": "FORBIDDEN",
"errorCode": "WORKSHOP_MANGO_FORBIDDEN",
"message": "You can not access this api with a TagMango account, only available for whitelabel hosts",
"result": "You can not access this api with a TagMango account, only available for whitelabel hosts",
"success": false
}{
"code": 429,
"type": "Too Many Requests",
"statusMessage": "TOO_MANY_REQUESTS",
"message": "Request limit exceeded. try after 10 seconds",
"result": "Request limit exceeded. try after 10 seconds",
"success": false
}