Docs home

Delete Session

Permanently deletes a session that has not started yet, along with its attendance records. Put the session's `attendance_id` in the URL. To keep the session visible as cancelled, use "Cancel Session" instead.

POST/schedule/version/session/{attendance_id}/delete
Delete Session
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/schedule/version/session/{attendance_id}/delete' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"delete_type":0}'
{
  "code": 200,
  "message": "Deleted Successfully"
}

Access: Institute admins and tutors, plus custom roles that can cancel or delete 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 delete.
BodyJSONString
0 this session only (default), 1 this and all later not-started sessions in the series, 2 the series' sessions between delete_start_date and delete_end_date.
delete_start_datestringYes if delete_type is 2
First date of the range.
delete_end_datestringYes if delete_type is 2
Last date of the range.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Deleted Successfully

Notes: This can't be undone. No notifications or webhooks are sent. Fails with code 25001 "Invalid Attendance ID" if the session doesn't exist, isn't yours, or has already started or been cancelled. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI