openapi: 3.2.0
info:
  title: Canvas LMS REST Quiz Submission User List API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Quiz Submission User List
  x-resource: quiz_submission_user_list
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html
paths:
  /v1/courses/{course_id}/quizzes/{id}/submission_users/message:
    post:
      tags:
      - Quiz Submission User List
      operationId: send_message_to_unsubmitted_or_submitted_users_for_quiz
      summary: Send a message to unsubmitted or submitted users for the quiz
      description: '{

        "body": {

        "type": "string",

        "description": "message body of the conversation to be created",

        "example": "Please take the quiz."

        },

        "recipients": {

        "type": "string",

        "description": "Who to send the message to. May be either ''submitted'' or ''unsubmitted''",

        "example": "submitted"

        },

        "subject": {

        "type": "string",

        "description": "Subject of the new Conversation created",

        "example": "ATTN: Quiz 101 Students"

        }

        }'
      parameters:
      - name: course_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                conversations:
                  type: string
                  x-canvas-declared-type: QuizUserConversation
                  description: '- Body and recipients to send the message to.'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                conversations:
                  type: string
                  x-canvas-declared-type: QuizUserConversation
                  description: '- Body and recipients to send the message to.'
      responses:
        '200':
          description: Success, no content returned
      externalDocs:
        url: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Canvas OAuth2 access token sent as "Authorization: Bearer <token>". See https://canvas.instructure.com/doc/api/file.oauth.html'
    oauth2:
      type: oauth2
      description: Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauth_endpoints.html
      flows:
        authorizationCode:
          authorizationUrl: https://canvas.instructure.com/login/oauth2/auth
          tokenUrl: https://canvas.instructure.com/login/oauth2/token
          refreshUrl: https://canvas.instructure.com/login/oauth2/token
          scopes: {}
externalDocs:
  description: Canvas LMS REST API Documentation
  url: https://canvas.instructure.com/doc/api/
x-generated-from: https://canvas.instructure.com/doc/api/api-docs.json
x-provenance:
  method: derived
  derived_by: API Evangelist enrichment pipeline (Swagger 1.2 -> OpenAPI 3.1 conversion)
  source: openapi/_original/swagger-1.2/*.json (144 verbatim first-party Swagger 1.2 documents)
  source_url: https://canvas.instructure.com/doc/api/api-docs.json
  fetched: '2026-09-05'
  http_status: 200