🚀 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.
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
PollSubmissions API
Manage submissions for polls
A PollSubmission object looks like:
{
// The unique identifier for the poll submission.
"id": 1023,
// The unique identifier of the poll choice chosen for this submission.
"poll_choice_id": 155,
// the unique identifier of the user who submitted this poll submission.
"user_id": 4555,
// The date and time the poll submission was submitted.
"created_at": "2013-11-07T13:16:18Z"
}
Get a single poll submission Polling::PollSubmissionsController#show
GET /api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions/:id
Scope:
url:GET|/api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions/:id
GET /courses/:course_id/files/:file_id/download
Scope:
url:GET|/courses/:course_id/files/:file_id/download
GET /courses/:course_id/files/:file_id/download.:type
Scope:
url:GET|/courses/:course_id/files/:file_id/download
GET /courses/:course_id/files/:file_id/preview
Scope:
url:GET|/courses/:course_id/files/:file_id/preview
GET /quiz_statistics/:quiz_statistics_id/files/:file_id/download
Scope:
url:GET|/quiz_statistics/:quiz_statistics_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download.:type
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/preview
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/preview
GET /groups/:group_id/files/:file_id/download
Scope:
url:GET|/groups/:group_id/files/:file_id/download
GET /groups/:group_id/files/:file_id/download.:type
Scope:
url:GET|/groups/:group_id/files/:file_id/download
GET /groups/:group_id/files/:file_id/preview
Scope:
url:GET|/groups/:group_id/files/:file_id/preview
GET /accounts/:account_id/files/:file_id/download
Scope:
url:GET|/accounts/:account_id/files/:file_id/download
GET /accounts/:account_id/files/:file_id/download.:type
Scope:
url:GET|/accounts/:account_id/files/:file_id/download
GET /accounts/:account_id/files/:file_id/preview
Scope:
url:GET|/accounts/:account_id/files/:file_id/preview
GET /users/:user_id/files/:file_id/download
Scope:
url:GET|/users/:user_id/files/:file_id/download
GET /users/:user_id/files/:file_id/download.:type
Scope:
url:GET|/users/:user_id/files/:file_id/download
GET /users/:user_id/files/:file_id/preview
Scope:
url:GET|/users/:user_id/files/:file_id/preview
GET /assignments/:assignment_id/files/:id/download
Scope:
url:GET|/assignments/:assignment_id/files/:id/download
GET /files/:file_id/download
Scope:
url:GET|/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download.:type
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/preview
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/preview
Returns the poll submission with the given id
Example Response:
{
"poll_submissions": [PollSubmission]
}
Create a single poll submission Polling::PollSubmissionsController#create
POST /api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions
Scope:
url:POST|/api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions
GET /courses/:course_id/files/:file_id/download
Scope:
url:GET|/courses/:course_id/files/:file_id/download
GET /courses/:course_id/files/:file_id/download.:type
Scope:
url:GET|/courses/:course_id/files/:file_id/download
GET /courses/:course_id/files/:file_id/preview
Scope:
url:GET|/courses/:course_id/files/:file_id/preview
GET /quiz_statistics/:quiz_statistics_id/files/:file_id/download
Scope:
url:GET|/quiz_statistics/:quiz_statistics_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download.:type
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/preview
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/preview
GET /groups/:group_id/files/:file_id/download
Scope:
url:GET|/groups/:group_id/files/:file_id/download
GET /groups/:group_id/files/:file_id/download.:type
Scope:
url:GET|/groups/:group_id/files/:file_id/download
GET /groups/:group_id/files/:file_id/preview
Scope:
url:GET|/groups/:group_id/files/:file_id/preview
GET /accounts/:account_id/files/:file_id/download
Scope:
url:GET|/accounts/:account_id/files/:file_id/download
GET /accounts/:account_id/files/:file_id/download.:type
Scope:
url:GET|/accounts/:account_id/files/:file_id/download
GET /accounts/:account_id/files/:file_id/preview
Scope:
url:GET|/accounts/:account_id/files/:file_id/preview
GET /users/:user_id/files/:file_id/download
Scope:
url:GET|/users/:user_id/files/:file_id/download
GET /users/:user_id/files/:file_id/download.:type
Scope:
url:GET|/users/:user_id/files/:file_id/download
GET /users/:user_id/files/:file_id/preview
Scope:
url:GET|/users/:user_id/files/:file_id/preview
GET /assignments/:assignment_id/files/:id/download
Scope:
url:GET|/assignments/:assignment_id/files/:id/download
GET /files/:file_id/download
Scope:
url:GET|/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download.:type
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/preview
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/preview
Create a new poll submission for this poll session
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| poll_submissions[][poll_choice_id] | Required | integer |
The chosen poll choice for this submission. |
Example Response:
{
"poll_submissions": [PollSubmission]
}