Docs home

Cancel Session

Cancels a session that has not started yet. Put the session's `attendance_id` in the URL. You can cancel just this session, this and all later sessions in its series, or the series' sessions in a date range. Cancelled sessions stay on the calendar with status Cancelled.

POST/schedule/version/session/{attendance_id}/cancel
Cancel Session
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/schedule/version/session/{attendance_id}/cancel' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"status":3,"send_sms":1,"master_batch_id":null,"cancel_type":0,"message_body":"Cancle Message"}'
{
  "code": 200,
  "message": "Canceled Successfully"
}

Access: Institute admins and tutors, plus custom roles that can cancel or delete sessions or manage mentoring sessions. The session must belong to a class in your organizations, or one you teach or created.

Request body: form-data with one field, JSONString, containing this JSON:

Path parameters
attendance_idintegerrequired
The session to cancel.
BodyJSONString
0 this session only (default), 1 this and all later not-started sessions in the series, 2 the series' not-started sessions between cancel_start_date and cancel_end_date.
cancel_start_datestringYes if cancel_type is 2
First date of the range, for example 2026-07-01.
cancel_end_datestringYes if cancel_type is 2
Last date of the range.
send_smsinteger
0 skips the cancellation SMS. Default 1.
A note passed on in the "session cancelled" webhook.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Canceled Successfully

Notes:

  • Fails with code 25001 "Invalid Attendance ID" if the session doesn't exist, isn't yours, or has already started or been cancelled.
  • Students in the session are told by email and SMS (or app notification, depending on your notification setup). If your institute has a "session cancelled" webhook, it is sent with the cancelled session IDs.
  • Mentoring sessions are cancelled through the mentoring flow, with its own notifications.
  • Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI