Docs home

Manual Reminder

Sends a reminder for an upcoming session to its students straight away. Put the session's `attendance_id` in the URL. No request body is needed.

POST/attendance/{attendanceId}/reminder
Manual Reminder
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/attendance/{attendanceId}/reminder' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success"
}

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

Path parameters
attendance_idintegerrequired
The session to remind about.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success

Notes: The reminder goes out by email and SMS (or through your institute's notification templates, depending on your notification setup). If your institute has a "session reminder" webhook, it is also sent. Each call sends another reminder, so avoid retrying in a loop. Fails with code 25001 "Invalid Attendance ID" if the session isn't found or isn't yours. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI