# us.off-the-clock.polls.poll

> Published by [off-the-clock.us](https://lexicon.garden/identity/did:plc:tevv7zpavtjtsvqrrwwipobt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.polls.poll)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.polls.poll/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.polls.poll/examples)

## Definitions

### `us.off-the-clock.polls.poll`

**Type**: `record`

A question a member asks a content space, with two to ten options that members answer with us.off-the-clock.polls.vote records. Each option is named by a key that stays the same when the poll is edited, so votes follow the option they were cast for. Posts may reply to a poll, so a poll heads a thread.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `allowMultiple` | `boolean` | No | Voters may choose any set of options; otherwise at most one. |
| `closesAt` | `string` (datetime) | No | Votes cast after this do not count. After opensAt when both are given. |
| `createdAt` | `string` (datetime) | Yes |  |
| `opensAt` | `string` (datetime) | No | Votes cast before this do not count. |
| `options` | `array` | Yes | In the order shown. Keys are unique within the poll. |
| `prompt` | `string` | Yes |  |

### `us.off-the-clock.polls.poll#option`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `allowInput` | `boolean` | No | A voter choosing this option may type an answer beside it. |
| `key` | `string` | Yes | Stable across edits and never reused within the poll; a vote names it. |
| `text` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A question a member asks a content space, with two to ten options that members answer with us.off-the-clock.polls.vote records. Each option is named by a key that stays the same when the poll is edited, so votes follow the option they were cast for. Posts may reply to a poll, so a poll heads a thread.",
      "key": "tid",
      "record": {
        "properties": {
          "allowMultiple": {
            "default": false,
            "description": "Voters may choose any set of options; otherwise at most one.",
            "type": "boolean"
          },
          "closesAt": {
            "description": "Votes cast after this do not count. After opensAt when both are given.",
            "format": "datetime",
            "type": "string"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "opensAt": {
            "description": "Votes cast before this do not count.",
            "format": "datetime",
            "type": "string"
          },
          "options": {
            "description": "In the order shown. Keys are unique within the poll.",
            "items": {
              "ref": "#option",
              "type": "ref"
            },
            "maxLength": 10,
            "minLength": 2,
            "type": "array"
          },
          "prompt": {
            "maxGraphemes": 300,
            "maxLength": 3000,
            "minGraphemes": 1,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "prompt",
          "options",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "option": {
      "properties": {
        "allowInput": {
          "default": false,
          "description": "A voter choosing this option may type an answer beside it.",
          "type": "boolean"
        },
        "key": {
          "description": "Stable across edits and never reused within the poll; a vote names it.",
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        "text": {
          "maxGraphemes": 80,
          "maxLength": 800,
          "minGraphemes": 1,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "text",
        "key"
      ],
      "type": "object"
    }
  },
  "id": "us.off-the-clock.polls.poll",
  "lexicon": 1
}
```