🚀 Heads up: Our API Docs Have Moved!
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.

Report Subscription Notifications API

Emails a user a link to a scheduled Canvas Career report. The email is sent immediately.

Send a report subscription notification ReportSubscriptionNotificationsController#create

POST /api/v1/users/:user_id/report_subscription_notifications

Scope: url:POST|/api/v1/users/:user_id/report_subscription_notifications
Emails the recipient a link to a generated report. Only internal services can call this endpoint: the caller must use a Site Admin developer key of an internal service with the service user client credentials flow, and its service user must be a Site Admin. Identify the recipient in the path by user UUID, as +uuid:<user_uuid>+. Requests are idempotent on +run_id+. A repeated request returns 200 with +duplicate+ set to true, and a repeat with different content returns 409.

Request Parameters:

Parameter Type Description
title Required string The email subject, up to 255 characters on a single line.
message Required string The email body, up to 5,000 characters.
download_url Required string An absolute http or https URL of the report download page.
manage_url string An absolute http or https URL of the page where the recipient manages their subscriptions. The email links to it when given.
run_id Required string Identifies the report run, up to 255 letters, digits, underscores, hyphens, dots or colons.

Example Request:

curl -X POST -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/users/uuid:<user_uuid>/report_subscription_notifications \
-d 'title=Weekly learner progress' \
-d 'message=Your scheduled report is ready.' \
-d 'download_url=https://career.example.com/report-runs/3f2a' \
-d 'run_id=3f2a'

Example Response:

{ "ok": true }