TagMangoTagMango Docs
Workshop

Cancel Recurring Workshop Series

DELETE
/api/v1/external/workshops/video-calls/groups/{groupId}

Cancel every currently eligible occurrence in a creator-owned workshop series. To cancel only one occurrence, use Cancel Workshop Occurrence. Send no body or cancellation reason.

Eligibility

  • Each selected occurrence must be a non-deleted workshop, not a consultation booking.
  • Its status must be upcoming or ongoing, and its start must be at least 60 seconds away when eligibility is checked; exactly 60 seconds is eligible.
  • Ineligible occurrences remain unchanged, including sessions already started or inside the 60-second window.
  • The operation considers the whole series without pagination or a per-request occurrence cap.

Result and side effects

  • The full retained series is returned, with every occurrence in chronological order and its resulting status.
  • Renumbering of remaining non-cancelled occurrences is attempted after cancellation; a refresh failure does not fail the request, so recurrence numbers can remain stale. Cancelled occurrences keep their stored recurrence numbers, and the group link is retained.
  • Cleanup of assigned Zoom sessions is attempted before cancellation statuses are written.
  • Cancellation emails, notifications, and automation webhooks are attempted asynchronously; a successful response does not guarantee delivery.

Errors and retries

If no occurrence is eligible, including on a repeat after all eligible occurrences were cancelled, the endpoint returns 400 WORKSHOP_CANCELLATION_NOT_ALLOWED with No videocalls found that can be cancelled. Missing and foreign series use the same error.

A malformed path ID returns the standard validation error with groupId 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 series 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.

AuthorizationBearer <token>

In: header

Path Parameters

groupId*string

The 24-character hexadecimal groupId returned by Get Video Call Details for an occurrence in the series.

Match^[0-9a-fA-F]{24}$
Length24 <= length <= 24

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

x-timezone-offset?integer

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/groups/66c4964c11e7fef26751f3a6" \  -H "x-whitelabel-host: string"
{
  "groupId": "66c4964c11e7fef26751f3a6",
  "recurringType": "weekly",
  "startDate": "2026-09-20",
  "endDate": "2026-10-18",
  "repeatingDays": [
    0,
    1,
    1,
    1,
    1,
    1,
    0
  ],
  "fromTime": "15:32",
  "duration": 60,
  "timezoneName": "Asia/Kolkata",
  "upcomingCount": 6,
  "completedCount": 2,
  "nextOccurrenceAt": "2026-09-27T10:02:00.000Z",
  "isEditable": true,
  "notEditableReason": "This group has an occurrence starting within 30 minutes",
  "occurrences": [
    {
      "_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
}