Docs home

Announcement Mark as Read

Marks an announcement as read for one learner, on their behalf. Use it when you show the learner the announcement in another channel and want Edmingle's unread count to match.

POST/admin/student/announcement/{studentId}
Announcement Mark as Read
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/admin/student/announcement/{studentId}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"institution_announcement_id":473}'
{
  "code": 200,
  "message": "Success"
}

Access: Institute admins and admins. The learner must belong to your ORGID organization.

Path parameters
student_idintegerrequired
ID of the learner, e.g. admin/student/announcement/43974.

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

BodyJSONString
ID of the announcement to mark as read.
pageintegerrequired
Required by validation but not used. Send 1.
per_pageintegerrequired
Required by validation but not used. Send 1.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success

Notes: Errors: "Annoucement Not found" (unknown announcement ID) and "student not found in organization". For an announcement sent to the whole organization, the learner's unread count is reset to 0. Rate limit: 200 requests per minute; going over locks you out for 5 minutes.

Updated yesterday

Ask AI