# PollChoices

{% hint style="warning" %}
**Welcome to Our New API Docs!** This is the new home for all things API (previously at [Canvas LMS REST API Documentation](https://api.instructure.com)).
{% endhint %}

## PollChoices API

Manage choices for polls

**A PollChoice object looks like:**

```js
{
  // The unique identifier for the poll choice.
  "id": 1023,
  // The id of the poll this poll choice belongs to.
  "poll_id": 1779,
  // Specifies whether or not this poll choice is a 'correct' choice.
  "is_correct": true,
  // The text of the poll choice.
  "text": "Choice A",
  // The order of the poll choice in relation to it's sibling poll choices.
  "position": 1
}
```

### [List poll choices in a poll](#method.polling/poll_choices.index) <a href="#method.polling-poll_choices.index" id="method.polling-poll_choices.index"></a>

[Polling::PollChoicesController#index](https://github.com/instructure/canvas-lms/blob/master/app/controllers/polling/poll_choices_controller.rb)

**`GET /api/v1/polls/:poll_id/poll_choices`**

**Scope:** `url:GET|/api/v1/polls/:poll_id/poll_choices`

Returns the paginated list of PollChoices in this poll.

**Example Response:**

```js
{
  "poll_choices": [PollChoice]
}
```

### [Get a single poll choice](#method.polling/poll_choices.show) <a href="#method.polling-poll_choices.show" id="method.polling-poll_choices.show"></a>

[Polling::PollChoicesController#show](https://github.com/instructure/canvas-lms/blob/master/app/controllers/polling/poll_choices_controller.rb)

**`GET /api/v1/polls/:poll_id/poll_choices/:id`**

**Scope:** `url:GET|/api/v1/polls/:poll_id/poll_choices/:id`

Returns the poll choice with the given id

**Example Response:**

```js
{
  "poll_choices": [PollChoice]
}
```

### [Create a single poll choice](#method.polling/poll_choices.create) <a href="#method.polling-poll_choices.create" id="method.polling-poll_choices.create"></a>

[Polling::PollChoicesController#create](https://github.com/instructure/canvas-lms/blob/master/app/controllers/polling/poll_choices_controller.rb)

**`POST /api/v1/polls/:poll_id/poll_choices`**

**Scope:** `url:POST|/api/v1/polls/:poll_id/poll_choices`

Create a new poll choice for this poll

**Request Parameters:**

| Parameter                    | Type              | Description                                                                             |
| ---------------------------- | ----------------- | --------------------------------------------------------------------------------------- |
| `poll_choices[][text]`       | Required `string` | The descriptive text of the poll choice.                                                |
| `poll_choices[][is_correct]` | `boolean`         | Whether this poll choice is considered correct or not. Defaults to false.               |
| `poll_choices[][position]`   | `integer`         | The order this poll choice should be returned in the context it’s sibling poll choices. |

**Example Response:**

```js
{
  "poll_choices": [PollChoice]
}
```

### [Update a single poll choice](#method.polling/poll_choices.update) <a href="#method.polling-poll_choices.update" id="method.polling-poll_choices.update"></a>

[Polling::PollChoicesController#update](https://github.com/instructure/canvas-lms/blob/master/app/controllers/polling/poll_choices_controller.rb)

**`PUT /api/v1/polls/:poll_id/poll_choices/:id`**

**Scope:** `url:PUT|/api/v1/polls/:poll_id/poll_choices/:id`

Update an existing poll choice for this poll

**Request Parameters:**

| Parameter                    | Type              | Description                                                                             |
| ---------------------------- | ----------------- | --------------------------------------------------------------------------------------- |
| `poll_choices[][text]`       | Required `string` | The descriptive text of the poll choice.                                                |
| `poll_choices[][is_correct]` | `boolean`         | Whether this poll choice is considered correct or not. Defaults to false.               |
| `poll_choices[][position]`   | `integer`         | The order this poll choice should be returned in the context it’s sibling poll choices. |

**Example Response:**

```js
{
  "poll_choices": [PollChoice]
}
```

### [Delete a poll choice](#method.polling/poll_choices.destroy) <a href="#method.polling-poll_choices.destroy" id="method.polling-poll_choices.destroy"></a>

[Polling::PollChoicesController#destroy](https://github.com/instructure/canvas-lms/blob/master/app/controllers/polling/poll_choices_controller.rb)

**`DELETE /api/v1/polls/:poll_id/poll_choices/:id`**

**Scope:** `url:DELETE|/api/v1/polls/:poll_id/poll_choices/:id`

**204 No Content** response code is returned if the deletion was successful.

***

This documentation is generated directly from the Canvas LMS source code, available [on Github](https://github.com/instructure/canvas-lms).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developerdocs.instructure.com/services/canvas/resources/poll_choices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.