Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.
Personal API token — find yours under My Account → API.
Headers
X-POLLUNIT-USER-IDENTIFIER
string
Your own identification of the user on whose behalf the request is made, any string. The user identifiers should not be guessable and stay secret, otherwise users could get access to other users' contents. Only used with a public API token: the created or changed object belongs to that anonymous user instead of the token owner, which keeps the user in control of it in later requests with the same identifier.
Path Parameters
poll_id
string
required
Poll member_hash or admin_hash
id
string
required
Option public_id, as returned in the id field
Query Parameters
organization_id
string
public_id of an organization the user belongs to. When given, the request runs in that organization context instead of the personal account.
Body
application/jsonmultipart/form-data
option
object
required
Attributes accepted when creating or updating an option. The option class is derived from the poll (or from the parent option for nested options) and cannot be set through the API.
Show child attributes
parent_option_id
string | null
public_id of a parent option to move the option to. Omit to keep the current parent.
additional_attributes
object | null
Values for the poll's additional_option_attributes. Omit to keep the stored values; when given, the hash replaces all of them, so it has to carry every required value.
Response
option updated
Full representation of a single poll option. Top-level fields vary by option type and are included conditionally depending on the poll's visibility settings and your access level (admin vs. member); type-specific configuration is grouped under settings.
id
string
required
Option public_id
public_url
string<uri>
required
type
string
required
Option STI class
Example:
"Options::TextOption"
admin_url
string<uri> | null
Admin access only
parent_option_id
string | null
content
string | null
subtitle
string | null
description
string | null
author_name
string | null
position
integer | null
state
enum<string> | null
Collection polls only
Available options:
incoming,
investigation,
planned,
in_implementation,
rejected,
done
rank
integer | null
rating
number<float> | null
average_rating
number<float> | null
best_rating
boolean | null
selected
boolean | null
child_option_type
string | null
data
object | null
Option-type-specific payload (e.g. location_data for location options)
drawing_type
enum<string> | null
Available options:
free_sketch,
sign,
draw_on_image
input_type
enum<string> | null
Input options only
Available options:
text,
textarea,
email,
url,
select,
radio,
multi_select,
checkbox,
number,
number_float,
file,
date,
datetime
location_type
enum<string> | null
Available options:
point,
route,
polygon,
circle,
rectangle,
points
options_count
integer | null
paid
boolean | null
privacy_policy_accepted
boolean | null
processing
boolean | null
rotation
integer | null
terms_accepted
boolean | null
info_link
string | null
info_link_title
string | null
is_other_answer
boolean
The "other" option of a select input.
start_date
string<date-time> | null
end_date
string<date-time> | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
video_thumb_path
string | null
vimeo_id
string | null
youtube_id
string | null
voter_count
integer | null
voting_category_option_ratings
object[]
Only for polls with voting_categories: the rating of the option per voting category. The rating fields follow the same visibility rules as the top-level ones.
Show child attributes
settings
object
Option-type-specific configuration, grouped for readability.
Show child attributes
attachment
object | null
URLs of the file uploaded to the option, returned by both the list and the show endpoint. Only present for option types that carry an uploaded file (image, photo, audio, drawing and advent calendar options); youtube/vimeo and uploaded-video options do not have it. The attachment_url_* keys are the processed derivatives that exist for this file, so which ones are returned depends on the uploaded file: images and videos get large, thumb and social, an audio file only gets cover if it has embedded cover art, and a file that is still processing has none at all. The whole object is omitted when none of its keys apply, e.g. an option without a file or a still-processing upload you have no download access to.
Show child attributes
approval_state
enum<string> | null
Admin access only
Available options:
unreviewed,
approved,
disapproved
approval_state_updated_at
string<date-time> | null
Admin access only
archived
boolean | null
Admin access only
fraudulent_count
integer | null
Admin access only
state_change_message
string | null
Admin access only
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PollUnit","colors":{"primary":"#2f2764","light":"#bd3291","dark":"#291f59"},"favicon":"https://mintcdn.com/pollunit/HKDmg2ko6DkcVWpB/favicon.ico?fit=max\u0026auto=format\u0026n=HKDmg2ko6DkcVWpB\u0026q=85\u0026s=7fd1f2334f16c39ca44fa501251df2a2","navbar":{"links":[{"href":"mailto:support@pollunit.com","label":"Support"}],"primary":{"type":"button","label":"PollUnit","href":"https://pollunit.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pollunit","hasAudioNarration":false,"actualSubdomain":"pollunit","customDomains":["api.pollunit.com"],"gitSource":{"type":"github","owner":"pollunit","repo":"pollunit","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afb522f93c081f90578794e","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Options","count":5},{"language":"default","tag":"Polls","count":5},{"language":"default","tag":"Voters","count":5},{"language":"default","tag":"Votes","count":5},{"language":"default","tag":"Documentation","count":1},{"language":"default","tag":"Get Started","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/options/update-option","slug":"/api-reference/options/update-option","pageMetadata":{"title":"Update option","description":"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/polls/{poll_id}/options/{id}","href":"/api-reference/options/update-option","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update option","description":"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/polls/{poll_id}/options/{id}","href":"/api-reference/options/update-option","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update option","tags":["Options"],"security":["1a07bccf-fc61-4c5f-815f-e97ff9244f19"],"description":"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.","parameters":["6d6fa06b-b635-40ea-ac8b-23c5aa76dda7"],"responses":{"200":"49dbbf1e-1e5d-4f24-bec8-b4ea844d296b","401":"b7f0428b-4513-4ccb-858a-4a842baca4d9","403":"f673cdb2-229d-4810-b841-f5e08b70df42","404":"4cee1bd3-c6ff-4d1e-9402-b3ce8f36abb7","422":"50fda7ea-f2d2-49de-8af8-69763926e0c4"},"requestBody":"1e0cccbb-5b00-4651-8286-4ea3e1d61a02","method":"patch","type":"path","servers":["7fbf2c69-60ff-4a6f-831e-7ed65259b3b1","00f9ae01-b7bf-4fe0-8c44-4fce4973b5cc"],"path":"/api/v1/polls/{poll_id}/options/{id}","baseUrlOptions":["https://pollunit.com","http://localhost:3000"],"title":"Update option","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6d6fa06b-b635-40ea-ac8b-23c5aa76dda7":{"name":"X-POLLUNIT-USER-IDENTIFIER","in":"header","required":false,"description":"Your own identification of the user on whose behalf the request is made, any string. The user identifiers should not be guessable and stay secret, otherwise users could get access to other users' contents. Only used with a public API token: the created or changed object belongs to that anonymous user instead of the token owner, which keeps the user in control of it in later requests with the same identifier.","schema":{"type":"string","isRequired":false,"description":"Your own identification of the user on whose behalf the request is made, any string. The user identifiers should not be guessable and stay secret, otherwise users could get access to other users' contents. Only used with a public API token: the created or changed object belongs to that anonymous user instead of the token owner, which keeps the user in control of it in later requests with the same identifier.","uniqueKey":"","typeLabel":"string"}},"17b96a80-687e-4c7b-96f5-945fe3cd691a":{"name":"poll_id","in":"path","description":"Poll member_hash or admin_hash","required":true,"schema":{"type":"string","isRequired":true,"description":"Poll member_hash or admin_hash","uniqueKey":"","typeLabel":"string"}},"39ca034b-4aff-46a4-91fc-501f03219882":{"name":"id","in":"path","description":"Option public_id, as returned in the id field","required":true,"schema":{"type":"string","isRequired":true,"description":"Option public_id, as returned in the id field","uniqueKey":"","typeLabel":"string"}},"4f62224e-c2d3-414f-9349-7e8f5152f281":{"name":"organization_id","in":"query","required":false,"description":"public_id of an organization the user belongs to. When given, the request runs in that organization context instead of the personal account.","schema":{"type":"string","isRequired":false,"description":"public_id of an organization the user belongs to. When given, the request runs in that organization context instead of the personal account.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"option":{"type":"object","description":"Attributes accepted when creating or updating an option. The option class is derived from the poll (or from the parent option for nested options) and cannot be set through the API.","properties":{"content":{"oneOf":[{"type":"string","example":"My option","description":"Title of the option. Required for most option types.","uniqueKey":"option.content.oneOf.0","typeLabel":"string"},{"type":"null","example":"My option","description":"Title of the option. Required for most option types.","uniqueKey":"option.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.content","typeLabel":"string | null"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"option.subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.subtitle","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"option.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.description","typeLabel":"string | null"},"author_name":{"oneOf":[{"type":"string","description":"Required when the poll has `require_author_name` and the request does not have admin access.","uniqueKey":"option.author_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required when the poll has `require_author_name` and the request does not have admin access.","uniqueKey":"option.author_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.author_name","typeLabel":"string | null"},"allowed_values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"option.allowed_values.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Selectable values of a `select`, `radio` or `multi_select` input option.","uniqueKey":"option.allowed_values.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Selectable values of a `select`, `radio` or `multi_select` input option.","uniqueKey":"option.allowed_values.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.allowed_values","typeLabel":"string[] | null"},"archived":{"oneOf":[{"type":"boolean","description":"Admin access only","uniqueKey":"option.archived.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Admin access only","uniqueKey":"option.archived.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.archived","typeLabel":"boolean | null"},"start_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"option.start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"option.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.start_date","typeLabel":"string\u003cdate-time> | null"},"end_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"option.end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"option.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.end_date","typeLabel":"string\u003cdate-time> | null"},"info_link":{"oneOf":[{"type":"string","uniqueKey":"option.info_link.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.info_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.info_link","typeLabel":"string | null"},"info_link_title":{"oneOf":[{"type":"string","uniqueKey":"option.info_link_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.info_link_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.info_link_title","typeLabel":"string | null"},"input_type":{"oneOf":[{"type":"string","description":"Input and column options only","enum":["text","textarea","email","url","select","radio","multi_select","checkbox","number","number_float","file","date","datetime"],"uniqueKey":"option.input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Input and column options only","enum":["text","textarea","email","url","select","radio","multi_select","checkbox","number","number_float","file","date","datetime"],"uniqueKey":"option.input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.input_type","typeLabel":"enum\u003cstring> | null"},"vimeo_id":{"oneOf":[{"type":"string","uniqueKey":"option.vimeo_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.vimeo_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.vimeo_id","typeLabel":"string | null"},"youtube_id":{"oneOf":[{"type":"string","uniqueKey":"option.youtube_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.youtube_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.youtube_id","typeLabel":"string | null"},"attachment":{"oneOf":[{"type":"string","format":"binary","description":"File for option types that carry an attachment (image, audio, video file and photo options). Only available with a `multipart/form-data` request, and ignored for option types without an attachment.","uniqueKey":"option.attachment.oneOf.0","typeLabel":"file"},{"type":"null","format":"binary","description":"File for option types that carry an attachment (image, audio, video file and photo options). Only available with a `multipart/form-data` request, and ignored for option types without an attachment.","uniqueKey":"option.attachment.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.attachment","typeLabel":"file | null"}},"isRequired":true,"uniqueKey":"option","typeLabel":"object"},"parent_option_id":{"oneOf":[{"type":"string","description":"public_id of a parent option to move the option to. Omit to keep the current parent.","uniqueKey":"parent_option_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"public_id of a parent option to move the option to. Omit to keep the current parent.","uniqueKey":"parent_option_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_option_id","typeLabel":"string | null"},"additional_attributes":{"oneOf":[{"type":"object","description":"Values for the poll's `additional_option_attributes`. Omit to keep the stored values; when given, the hash replaces all of them, so it has to carry every required value.","uniqueKey":"additional_attributes.oneOf.0","typeLabel":"object"},{"type":"null","description":"Values for the poll's `additional_option_attributes`. Omit to keep the stored values; when given, the hash replaces all of them, so it has to carry every required value.","uniqueKey":"additional_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_attributes","typeLabel":"object | null"}},"required":["option"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"option":{"content":"My option","subtitle":"\u003cstring>","description":"\u003cstring>","author_name":"\u003cstring>","allowed_values":["\u003cstring>"],"archived":true,"start_date":"2023-11-07T05:31:56Z","end_date":"2023-11-07T05:31:56Z","info_link":"\u003cstring>","info_link_title":"\u003cstring>","vimeo_id":"\u003cstring>","youtube_id":"\u003cstring>","attachment":"\u003cstring>"},"parent_option_id":"\u003cstring>","additional_attributes":{}}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"option":{"type":"object","description":"Attributes accepted when creating or updating an option. The option class is derived from the poll (or from the parent option for nested options) and cannot be set through the API.","properties":{"content":{"oneOf":[{"type":"string","example":"My option","description":"Title of the option. Required for most option types.","uniqueKey":"option.content.oneOf.0","typeLabel":"string"},{"type":"null","example":"My option","description":"Title of the option. Required for most option types.","uniqueKey":"option.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.content","typeLabel":"string | null"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"option.subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.subtitle","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"option.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.description","typeLabel":"string | null"},"author_name":{"oneOf":[{"type":"string","description":"Required when the poll has `require_author_name` and the request does not have admin access.","uniqueKey":"option.author_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required when the poll has `require_author_name` and the request does not have admin access.","uniqueKey":"option.author_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.author_name","typeLabel":"string | null"},"allowed_values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"option.allowed_values.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Selectable values of a `select`, `radio` or `multi_select` input option.","uniqueKey":"option.allowed_values.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Selectable values of a `select`, `radio` or `multi_select` input option.","uniqueKey":"option.allowed_values.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.allowed_values","typeLabel":"string[] | null"},"archived":{"oneOf":[{"type":"boolean","description":"Admin access only","uniqueKey":"option.archived.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Admin access only","uniqueKey":"option.archived.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.archived","typeLabel":"boolean | null"},"start_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"option.start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"option.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.start_date","typeLabel":"string\u003cdate-time> | null"},"end_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"option.end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"option.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.end_date","typeLabel":"string\u003cdate-time> | null"},"info_link":{"oneOf":[{"type":"string","uniqueKey":"option.info_link.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.info_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.info_link","typeLabel":"string | null"},"info_link_title":{"oneOf":[{"type":"string","uniqueKey":"option.info_link_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.info_link_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.info_link_title","typeLabel":"string | null"},"input_type":{"oneOf":[{"type":"string","description":"Input and column options only","enum":["text","textarea","email","url","select","radio","multi_select","checkbox","number","number_float","file","date","datetime"],"uniqueKey":"option.input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Input and column options only","enum":["text","textarea","email","url","select","radio","multi_select","checkbox","number","number_float","file","date","datetime"],"uniqueKey":"option.input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.input_type","typeLabel":"enum\u003cstring> | null"},"vimeo_id":{"oneOf":[{"type":"string","uniqueKey":"option.vimeo_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.vimeo_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.vimeo_id","typeLabel":"string | null"},"youtube_id":{"oneOf":[{"type":"string","uniqueKey":"option.youtube_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"option.youtube_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.youtube_id","typeLabel":"string | null"},"attachment":{"oneOf":[{"type":"string","format":"binary","description":"File for option types that carry an attachment (image, audio, video file and photo options). Only available with a `multipart/form-data` request, and ignored for option types without an attachment.","uniqueKey":"option.attachment.oneOf.0","typeLabel":"file"},{"type":"null","format":"binary","description":"File for option types that carry an attachment (image, audio, video file and photo options). Only available with a `multipart/form-data` request, and ignored for option types without an attachment.","uniqueKey":"option.attachment.oneOf.1","typeLabel":"null"}],"uniqueKey":"option.attachment","typeLabel":"file | null"}},"isRequired":true,"uniqueKey":"option","typeLabel":"object"},"parent_option_id":{"oneOf":[{"type":"string","description":"public_id of a parent option to move the option to. Omit to keep the current parent.","uniqueKey":"parent_option_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"public_id of a parent option to move the option to. Omit to keep the current parent.","uniqueKey":"parent_option_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_option_id","typeLabel":"string | null"},"additional_attributes":{"oneOf":[{"type":"object","description":"Values for the poll's `additional_option_attributes`. Omit to keep the stored values; when given, the hash replaces all of them, so it has to carry every required value.","uniqueKey":"additional_attributes.oneOf.0","typeLabel":"object"},{"type":"null","description":"Values for the poll's `additional_option_attributes`. Omit to keep the stored values; when given, the hash replaces all of them, so it has to carry every required value.","uniqueKey":"additional_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_attributes","typeLabel":"object | null"}},"required":["option"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"option":{"content":"My option","subtitle":"\u003cstring>","description":"\u003cstring>","author_name":"\u003cstring>","allowed_values":["\u003cstring>"],"archived":true,"start_date":"2023-11-07T05:31:56Z","end_date":"2023-11-07T05:31:56Z","info_link":"\u003cstring>","info_link_title":"\u003cstring>","vimeo_id":"\u003cstring>","youtube_id":"\u003cstring>","attachment":"\u003cstring>"},"parent_option_id":"\u003cstring>","additional_attributes":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"49dbbf1e-1e5d-4f24-bec8-b4ea844d296b":{"description":"option updated","content":{"application/json":{"schema":{"type":"object","description":"Full representation of a single poll option. Top-level fields vary by option type and are included conditionally depending on the poll's visibility settings and your access level (admin vs. member); type-specific configuration is grouped under `settings`.","properties":{"id":{"type":"string","description":"Option public_id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"public_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"public_url","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Option STI class","example":"Options::TextOption","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"admin_url":{"oneOf":[{"type":"string","format":"uri","description":"Admin access only","uniqueKey":"admin_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Admin access only","uniqueKey":"admin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"admin_url","typeLabel":"string\u003curi> | null"},"parent_option_id":{"oneOf":[{"type":"string","uniqueKey":"parent_option_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"parent_option_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_option_id","typeLabel":"string | null"},"content":{"oneOf":[{"type":"string","uniqueKey":"content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.oneOf.1","typeLabel":"null"}],"uniqueKey":"content","typeLabel":"string | null"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"subtitle","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"author_name":{"oneOf":[{"type":"string","uniqueKey":"author_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"author_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"author_name","typeLabel":"string | null"},"position":{"oneOf":[{"type":"integer","uniqueKey":"position.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"position.oneOf.1","typeLabel":"null"}],"uniqueKey":"position","typeLabel":"integer | null"},"state":{"oneOf":[{"type":"string","enum":["incoming","investigation","planned","in_implementation","rejected","done"],"description":"Collection polls only","uniqueKey":"state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["incoming","investigation","planned","in_implementation","rejected","done"],"description":"Collection polls only","uniqueKey":"state.oneOf.1","typeLabel":"null"}],"uniqueKey":"state","typeLabel":"enum\u003cstring> | null"},"rank":{"oneOf":[{"type":"integer","uniqueKey":"rank.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"rank.oneOf.1","typeLabel":"null"}],"uniqueKey":"rank","typeLabel":"integer | null"},"rating":{"oneOf":[{"type":"number","format":"float","uniqueKey":"rating.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating","typeLabel":"number\u003cfloat> | null"},"average_rating":{"oneOf":[{"type":"number","format":"float","uniqueKey":"average_rating.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"average_rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"average_rating","typeLabel":"number\u003cfloat> | null"},"best_rating":{"oneOf":[{"type":"boolean","uniqueKey":"best_rating.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"best_rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"best_rating","typeLabel":"boolean | null"},"selected":{"oneOf":[{"type":"boolean","uniqueKey":"selected.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"selected.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected","typeLabel":"boolean | null"},"child_option_type":{"oneOf":[{"type":"string","uniqueKey":"child_option_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"child_option_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"child_option_type","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","description":"Option-type-specific payload (e.g. location_data for location options)","uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Option-type-specific payload (e.g. location_data for location options)","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"},"drawing_type":{"oneOf":[{"type":"string","enum":["free_sketch","sign","draw_on_image"],"uniqueKey":"drawing_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["free_sketch","sign","draw_on_image"],"uniqueKey":"drawing_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"drawing_type","typeLabel":"enum\u003cstring> | null"},"input_type":{"oneOf":[{"type":"string","description":"Input options only","enum":["text","textarea","email","url","select","radio","multi_select","checkbox","number","number_float","file","date","datetime"],"uniqueKey":"input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Input options only","enum":["text","textarea","email","url","select","radio","multi_select","checkbox","number","number_float","file","date","datetime"],"uniqueKey":"input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"input_type","typeLabel":"enum\u003cstring> | null"},"location_type":{"oneOf":[{"type":"string","enum":["point","route","polygon","circle","rectangle","points"],"uniqueKey":"location_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["point","route","polygon","circle","rectangle","points"],"uniqueKey":"location_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"location_type","typeLabel":"enum\u003cstring> | null"},"options_count":{"oneOf":[{"type":"integer","uniqueKey":"options_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"options_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"options_count","typeLabel":"integer | null"},"paid":{"oneOf":[{"type":"boolean","uniqueKey":"paid.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"paid.oneOf.1","typeLabel":"null"}],"uniqueKey":"paid","typeLabel":"boolean | null"},"privacy_policy_accepted":{"oneOf":[{"type":"boolean","uniqueKey":"privacy_policy_accepted.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"privacy_policy_accepted.oneOf.1","typeLabel":"null"}],"uniqueKey":"privacy_policy_accepted","typeLabel":"boolean | null"},"processing":{"oneOf":[{"type":"boolean","uniqueKey":"processing.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"processing.oneOf.1","typeLabel":"null"}],"uniqueKey":"processing","typeLabel":"boolean | null"},"rotation":{"oneOf":[{"type":"integer","uniqueKey":"rotation.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"rotation.oneOf.1","typeLabel":"null"}],"uniqueKey":"rotation","typeLabel":"integer | null"},"terms_accepted":{"oneOf":[{"type":"boolean","uniqueKey":"terms_accepted.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"terms_accepted.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_accepted","typeLabel":"boolean | null"},"info_link":{"oneOf":[{"type":"string","uniqueKey":"info_link.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"info_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"info_link","typeLabel":"string | null"},"info_link_title":{"oneOf":[{"type":"string","uniqueKey":"info_link_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"info_link_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"info_link_title","typeLabel":"string | null"},"is_other_answer":{"type":"boolean","description":"The \"other\" option of a select input.","uniqueKey":"is_other_answer","typeLabel":"boolean"},"start_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"start_date","typeLabel":"string\u003cdate-time> | null"},"end_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_date","typeLabel":"string\u003cdate-time> | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"},"video_thumb_path":{"oneOf":[{"type":"string","uniqueKey":"video_thumb_path.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"video_thumb_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"video_thumb_path","typeLabel":"string | null"},"vimeo_id":{"oneOf":[{"type":"string","uniqueKey":"vimeo_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"vimeo_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"vimeo_id","typeLabel":"string | null"},"youtube_id":{"oneOf":[{"type":"string","uniqueKey":"youtube_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"youtube_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"youtube_id","typeLabel":"string | null"},"voter_count":{"oneOf":[{"type":"integer","uniqueKey":"voter_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"voter_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"voter_count","typeLabel":"integer | null"},"voting_category_option_ratings":{"type":"array","description":"Only for polls with `voting_categories`: the rating of the option per voting category. The rating fields follow the same visibility rules as the top-level ones.","items":{"type":"object","properties":{"voting_category_id":{"type":"integer","isRequired":true,"uniqueKey":"voting_category_option_ratings.items.[INDEX].voting_category_id","typeLabel":"integer"},"rating":{"oneOf":[{"type":"number","format":"float","uniqueKey":"voting_category_option_ratings.items.[INDEX].rating.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"voting_category_option_ratings.items.[INDEX].rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"voting_category_option_ratings.items.[INDEX].rating","typeLabel":"number\u003cfloat> | null"},"average_rating":{"oneOf":[{"type":"number","format":"float","uniqueKey":"voting_category_option_ratings.items.[INDEX].average_rating.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"voting_category_option_ratings.items.[INDEX].average_rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"voting_category_option_ratings.items.[INDEX].average_rating","typeLabel":"number\u003cfloat> | null"},"best_rating":{"oneOf":[{"type":"boolean","uniqueKey":"voting_category_option_ratings.items.[INDEX].best_rating.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"voting_category_option_ratings.items.[INDEX].best_rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"voting_category_option_ratings.items.[INDEX].best_rating","typeLabel":"boolean | null"},"selected":{"oneOf":[{"type":"boolean","uniqueKey":"voting_category_option_ratings.items.[INDEX].selected.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"voting_category_option_ratings.items.[INDEX].selected.oneOf.1","typeLabel":"null"}],"uniqueKey":"voting_category_option_ratings.items.[INDEX].selected","typeLabel":"boolean | null"}},"required":["voting_category_id"],"uniqueKey":"voting_category_option_ratings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voting_category_option_ratings","typeLabel":"object[]"},"settings":{"type":"object","description":"Option-type-specific configuration, grouped for readability.","properties":{"allow_other_answer":{"oneOf":[{"type":"boolean","description":"Select inputs only. Adds an \"other\" option with a free text answer.","uniqueKey":"settings.allow_other_answer.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Select inputs only. Adds an \"other\" option with a free text answer.","uniqueKey":"settings.allow_other_answer.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.allow_other_answer","typeLabel":"boolean | null"},"allowed_values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"settings.allowed_values.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"settings.allowed_values.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"settings.allowed_values.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.allowed_values","typeLabel":"string[] | null"},"column_width":{"oneOf":[{"type":"integer","uniqueKey":"settings.column_width.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"settings.column_width.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.column_width","typeLabel":"integer | null"},"correct_values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"settings.correct_values.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Fields of quiz steps (`entry_quiz`) only, admin access only. Accepted answers; for checkboxes `1` (checked) or `0` (unchecked).","uniqueKey":"settings.correct_values.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Fields of quiz steps (`entry_quiz`) only, admin access only. Accepted answers; for checkboxes `1` (checked) or `0` (unchecked).","uniqueKey":"settings.correct_values.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.correct_values","typeLabel":"string[] | null"},"points_value":{"oneOf":[{"type":"integer","description":"Fields of quiz steps (`entry_quiz`) only, admin access only. Points for a correct answer when `require_correct_answers` is false.","uniqueKey":"settings.points_value.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Fields of quiz steps (`entry_quiz`) only, admin access only. Points for a correct answer when `require_correct_answers` is false.","uniqueKey":"settings.points_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.points_value","typeLabel":"integer | null"},"dot_vote_icon":{"oneOf":[{"type":"string","enum":["dot","heart","star","yes"],"uniqueKey":"settings.dot_vote_icon.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["dot","heart","star","yes"],"uniqueKey":"settings.dot_vote_icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.dot_vote_icon","typeLabel":"enum\u003cstring> | null"},"mandatory":{"oneOf":[{"type":"boolean","uniqueKey":"settings.mandatory.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"settings.mandatory.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.mandatory","typeLabel":"boolean | null"},"multiline":{"oneOf":[{"type":"boolean","uniqueKey":"settings.multiline.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"settings.multiline.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.multiline","typeLabel":"boolean | null"},"random_subset_size":{"oneOf":[{"type":"integer","description":"Survey steps only. Each participant answers this many randomly chosen options.","uniqueKey":"settings.random_subset_size.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Survey steps only. Each participant answers this many randomly chosen options.","uniqueKey":"settings.random_subset_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.random_subset_size","typeLabel":"integer | null"},"randomize_options":{"oneOf":[{"type":"boolean","uniqueKey":"settings.randomize_options.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"settings.randomize_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.randomize_options","typeLabel":"boolean | null"},"require_correct_answers":{"oneOf":[{"type":"boolean","description":"Survey steps only.","uniqueKey":"settings.require_correct_answers.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Survey steps only.","uniqueKey":"settings.require_correct_answers.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.require_correct_answers","typeLabel":"boolean | null"},"require_vote":{"oneOf":[{"type":"boolean","uniqueKey":"settings.require_vote.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"settings.require_vote.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.require_vote","typeLabel":"boolean | null"},"show_as_list":{"oneOf":[{"type":"boolean","uniqueKey":"settings.show_as_list.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"settings.show_as_list.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.show_as_list","typeLabel":"boolean | null"},"survey_step_rating_method":{"oneOf":[{"type":"string","enum":["average_by_voted","average_by_all_voters"],"description":"Survey steps only.","uniqueKey":"settings.survey_step_rating_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["average_by_voted","average_by_all_voters"],"description":"Survey steps only.","uniqueKey":"settings.survey_step_rating_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.survey_step_rating_method","typeLabel":"enum\u003cstring> | null"},"survey_step_type":{"oneOf":[{"type":"string","enum":["info","entry","rating","choice","drawing","location","entry_quiz"],"uniqueKey":"settings.survey_step_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["info","entry","rating","choice","drawing","location","entry_quiz"],"uniqueKey":"settings.survey_step_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.survey_step_type","typeLabel":"enum\u003cstring> | null"},"survey_step_vote_limit_per_option":{"oneOf":[{"type":"integer","uniqueKey":"settings.survey_step_vote_limit_per_option.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"settings.survey_step_vote_limit_per_option.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.survey_step_vote_limit_per_option","typeLabel":"integer | null"},"survey_step_vote_limit_per_option_min":{"oneOf":[{"type":"integer","uniqueKey":"settings.survey_step_vote_limit_per_option_min.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"settings.survey_step_vote_limit_per_option_min.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.survey_step_vote_limit_per_option_min","typeLabel":"integer | null"},"survey_step_vote_limit_per_voter":{"oneOf":[{"type":"integer","uniqueKey":"settings.survey_step_vote_limit_per_voter.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"settings.survey_step_vote_limit_per_voter.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.survey_step_vote_limit_per_voter","typeLabel":"integer | null"},"survey_step_vote_type":{"oneOf":[{"type":"string","enum":["Votes::BooleanVote","Votes::BooleanPlusVote","Votes::BooleanThumbVote","Votes::BooleanPlusThumbVote","Votes::BooleanHeartVote","Votes::RatingVote","Votes::DotVote","Votes::RangeVote","Votes::EmojiVote","Votes::SuperlativeVote","Votes::RankedVote","Votes::MatrixVotes::AgreementVote","Votes::MatrixVotes::BestVote","Votes::MatrixVotes::FrequencyVote","Votes::MatrixVotes::ImportanceVote","Votes::MatrixVotes::LikelihoodVote","Votes::MatrixVotes::LoveHateVote","Votes::MatrixVotes::SatisfactionVote","Votes::MatrixVotes::YesNoVote","Votes::MatrixVotes::CustomVote","Votes::FileVote","Votes::InputVote","Votes::LocationVote"],"description":"Survey steps only. The allowed subset depends on `survey_step_type`.","uniqueKey":"settings.survey_step_vote_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Votes::BooleanVote","Votes::BooleanPlusVote","Votes::BooleanThumbVote","Votes::BooleanPlusThumbVote","Votes::BooleanHeartVote","Votes::RatingVote","Votes::DotVote","Votes::RangeVote","Votes::EmojiVote","Votes::SuperlativeVote","Votes::RankedVote","Votes::MatrixVotes::AgreementVote","Votes::MatrixVotes::BestVote","Votes::MatrixVotes::FrequencyVote","Votes::MatrixVotes::ImportanceVote","Votes::MatrixVotes::LikelihoodVote","Votes::MatrixVotes::LoveHateVote","Votes::MatrixVotes::SatisfactionVote","Votes::MatrixVotes::YesNoVote","Votes::MatrixVotes::CustomVote","Votes::FileVote","Votes::InputVote","Votes::LocationVote"],"description":"Survey steps only. The allowed subset depends on `survey_step_type`.","uniqueKey":"settings.survey_step_vote_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.survey_step_vote_type","typeLabel":"enum\u003cstring> | null"},"voter_limit":{"oneOf":[{"type":"integer","uniqueKey":"settings.voter_limit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"settings.voter_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.voter_limit","typeLabel":"integer | null"}},"uniqueKey":"settings","typeLabel":"object"},"attachment":{"oneOf":[{"type":"object","description":"URLs of the file uploaded to the option, returned by both the list and the show endpoint. Only present for option types that carry an uploaded file (image, photo, audio, drawing and advent calendar options); youtube/vimeo and uploaded-video options do not have it. The `attachment_url_*` keys are the processed derivatives that exist for this file, so which ones are returned depends on the uploaded file: images and videos get `large`, `thumb` and `social`, an audio file only gets `cover` if it has embedded cover art, and a file that is still processing has none at all. The whole object is omitted when none of its keys apply, e.g. an option without a file or a still-processing upload you have no download access to.","properties":{"attachment_url_large":{"oneOf":[{"type":"string","format":"uri","description":"Long edge resized to 1920px (webp).","uniqueKey":"attachment.oneOf.0.attachment_url_large.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Long edge resized to 1920px (webp).","uniqueKey":"attachment.oneOf.0.attachment_url_large.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment.oneOf.0.attachment_url_large","typeLabel":"string\u003curi> | null"},"attachment_url_thumb":{"oneOf":[{"type":"string","format":"uri","description":"Width resized to 496px (webp).","uniqueKey":"attachment.oneOf.0.attachment_url_thumb.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Width resized to 496px (webp).","uniqueKey":"attachment.oneOf.0.attachment_url_thumb.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment.oneOf.0.attachment_url_thumb","typeLabel":"string\u003curi> | null"},"attachment_url_social":{"oneOf":[{"type":"string","format":"uri","description":"Long edge resized to 1200px (jpg), used for social media previews.","uniqueKey":"attachment.oneOf.0.attachment_url_social.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Long edge resized to 1200px (jpg), used for social media previews.","uniqueKey":"attachment.oneOf.0.attachment_url_social.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment.oneOf.0.attachment_url_social","typeLabel":"string\u003curi> | null"},"attachment_url_cover":{"oneOf":[{"type":"string","format":"uri","description":"Cover art extracted from an audio file.","uniqueKey":"attachment.oneOf.0.attachment_url_cover.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Cover art extracted from an audio file.","uniqueKey":"attachment.oneOf.0.attachment_url_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment.oneOf.0.attachment_url_cover","typeLabel":"string\u003curi> | null"},"attachment_original_url":{"oneOf":[{"type":"string","format":"uri","description":"The file as it was uploaded. Admin access only. For images and videos this falls back to the `large` derivative unless the account keeps source files.","uniqueKey":"attachment.oneOf.0.attachment_original_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The file as it was uploaded. Admin access only. For images and videos this falls back to the `large` derivative unless the account keeps source files.","uniqueKey":"attachment.oneOf.0.attachment_original_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment.oneOf.0.attachment_original_url","typeLabel":"string\u003curi> | null"}},"uniqueKey":"attachment.oneOf.0","typeLabel":"object"},{"type":"null","description":"URLs of the file uploaded to the option, returned by both the list and the show endpoint. Only present for option types that carry an uploaded file (image, photo, audio, drawing and advent calendar options); youtube/vimeo and uploaded-video options do not have it. The `attachment_url_*` keys are the processed derivatives that exist for this file, so which ones are returned depends on the uploaded file: images and videos get `large`, `thumb` and `social`, an audio file only gets `cover` if it has embedded cover art, and a file that is still processing has none at all. The whole object is omitted when none of its keys apply, e.g. an option without a file or a still-processing upload you have no download access to.","properties":{"attachment_url_large":{"oneOf":[{"type":"string","format":"uri","description":"Long edge resized to 1920px (webp)."},{"type":"null","format":"uri","description":"Long edge resized to 1920px (webp)."}]},"attachment_url_thumb":{"oneOf":[{"type":"string","format":"uri","description":"Width resized to 496px (webp)."},{"type":"null","format":"uri","description":"Width resized to 496px (webp)."}]},"attachment_url_social":{"oneOf":[{"type":"string","format":"uri","description":"Long edge resized to 1200px (jpg), used for social media previews."},{"type":"null","format":"uri","description":"Long edge resized to 1200px (jpg), used for social media previews."}]},"attachment_url_cover":{"oneOf":[{"type":"string","format":"uri","description":"Cover art extracted from an audio file."},{"type":"null","format":"uri","description":"Cover art extracted from an audio file."}]},"attachment_original_url":{"oneOf":[{"type":"string","format":"uri","description":"The file as it was uploaded. Admin access only. For images and videos this falls back to the `large` derivative unless the account keeps source files."},{"type":"null","format":"uri","description":"The file as it was uploaded. Admin access only. For images and videos this falls back to the `large` derivative unless the account keeps source files."}]}},"uniqueKey":"attachment.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachment","typeLabel":"object | null"},"approval_state":{"oneOf":[{"type":"string","description":"Admin access only","enum":["unreviewed","approved","disapproved"],"uniqueKey":"approval_state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Admin access only","enum":["unreviewed","approved","disapproved"],"uniqueKey":"approval_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"approval_state","typeLabel":"enum\u003cstring> | null"},"approval_state_updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Admin access only","uniqueKey":"approval_state_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Admin access only","uniqueKey":"approval_state_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"approval_state_updated_at","typeLabel":"string\u003cdate-time> | null"},"archived":{"oneOf":[{"type":"boolean","description":"Admin access only","uniqueKey":"archived.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Admin access only","uniqueKey":"archived.oneOf.1","typeLabel":"null"}],"uniqueKey":"archived","typeLabel":"boolean | null"},"fraudulent_count":{"oneOf":[{"type":"integer","description":"Admin access only","uniqueKey":"fraudulent_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Admin access only","uniqueKey":"fraudulent_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"fraudulent_count","typeLabel":"integer | null"},"state_change_message":{"oneOf":[{"type":"string","description":"Admin access only","uniqueKey":"state_change_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Admin access only","uniqueKey":"state_change_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"state_change_message","typeLabel":"string | null"}},"required":["id","type","public_url"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","public_url":"\u003cstring>","type":"Options::TextOption","admin_url":"\u003cstring>","parent_option_id":"\u003cstring>","content":"\u003cstring>","subtitle":"\u003cstring>","description":"\u003cstring>","author_name":"\u003cstring>","position":123,"state":"incoming","rank":123,"rating":123,"average_rating":123,"best_rating":true,"selected":true,"child_option_type":"\u003cstring>","data":{},"drawing_type":"free_sketch","input_type":"text","location_type":"point","options_count":123,"paid":true,"privacy_policy_accepted":true,"processing":true,"rotation":123,"terms_accepted":true,"info_link":"\u003cstring>","info_link_title":"\u003cstring>","is_other_answer":true,"start_date":"2023-11-07T05:31:56Z","end_date":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","video_thumb_path":"\u003cstring>","vimeo_id":"\u003cstring>","youtube_id":"\u003cstring>","voter_count":123,"voting_category_option_ratings":[{"voting_category_id":123,"rating":123,"average_rating":123,"best_rating":true,"selected":true}],"settings":{"allow_other_answer":true,"allowed_values":["\u003cstring>"],"column_width":123,"correct_values":["\u003cstring>"],"points_value":123,"dot_vote_icon":"dot","mandatory":true,"multiline":true,"random_subset_size":123,"randomize_options":true,"require_correct_answers":true,"require_vote":true,"show_as_list":true,"survey_step_rating_method":"average_by_voted","survey_step_type":"info","survey_step_vote_limit_per_option":123,"survey_step_vote_limit_per_option_min":123,"survey_step_vote_limit_per_voter":123,"survey_step_vote_type":"Votes::BooleanVote","voter_limit":123},"attachment":{"attachment_url_large":"\u003cstring>","attachment_url_thumb":"\u003cstring>","attachment_url_social":"\u003cstring>","attachment_url_cover":"\u003cstring>","attachment_original_url":"\u003cstring>"},"approval_state":"unreviewed","approval_state_updated_at":"2023-11-07T05:31:56Z","archived":true,"fraudulent_count":123,"state_change_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b7f0428b-4513-4ccb-858a-4a842baca4d9":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Unauthorized","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"f673cdb2-229d-4810-b841-f5e08b70df42":{"description":"forbidden (the option belongs to somebody else)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"4cee1bd3-c6ff-4d1e-9402-b3ce8f36abb7":{"description":"option not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Not Found","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Not Found"}}},"exampleType":"generated"}},"exampleType":"generated"},"50fda7ea-f2d2-49de-8af8-69763926e0c4":{"description":"invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Unprocessable Entity","uniqueKey":"error","typeLabel":"string"},"errors":{"type":"object","uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unprocessable Entity","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1a07bccf-fc61-4c5f-815f-e97ff9244f19":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"opaque","description":"Personal API token — find yours under My Account → API.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7fbf2c69-60ff-4a6f-831e-7ed65259b3b1":{"url":"https://pollunit.com","description":"Production"},"00f9ae01-b7bf-4fe0-8c44-4fce4973b5cc":{"url":"http://localhost:3000","description":"Development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"opaque","description":"Personal API token — find yours under My Account → API.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal API token — find yours under My Account → API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"pollunit","siteName":"PollUnit","title":"Update option - PollUnit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T18:57:55.298Z","originalFileLocation":"api-reference/options/update-option.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PollUnit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update option - PollUnit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PollUnit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api.pollunit.com/api-reference/options/update-option\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pollunit.mintlify.site/_mintlify/api/og/v2?division=Options\u0026amp;title=Update+option\u0026amp;description=Changes+an+existing+option.+Only+the+given+attributes+are+written%2C+the+others+keep+their+value.+Admin+access+through+the+admin_hash+may+change+every+option%3B+oth\u0026amp;theme=813251144f35da2ab9c2d600\u0026amp;signature=9440685f33e36f1a25adac72cf38fcab0729dce4470c1f61695347ff91cb6d63\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update option - PollUnit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pollunit.mintlify.site/_mintlify/api/og/v2?division=Options\u0026amp;title=Update+option\u0026amp;description=Changes+an+existing+option.+Only+the+given+attributes+are+written%2C+the+others+keep+their+value.+Admin+access+through+the+admin_hash+may+change+every+option%3B+oth\u0026amp;theme=813251144f35da2ab9c2d600\u0026amp;signature=9440685f33e36f1a25adac72cf38fcab0729dce4470c1f61695347ff91cb6d63\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/pollunit/d9wg8P6JU-qmnqtA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PollUnit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2f2764\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api.pollunit.com/api-reference/options/update-option\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/options/update-option.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api.pollunit.com/#organization\",\"name\":\"PollUnit\",\"url\":\"https://api.pollunit.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://api.pollunit.com#website\",\"name\":\"PollUnit\",\"url\":\"https://api.pollunit.com\",\"publisher\":{\"@id\":\"https://api.pollunit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api.pollunit.com/api-reference/options/update-option#webpage\",\"url\":\"https://api.pollunit.com/api-reference/options/update-option\",\"name\":\"Update option\",\"description\":\"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.\",\"dateModified\":\"2026-11-16T18:57:55.298Z\",\"isPartOf\":{\"@id\":\"https://api.pollunit.com#website\"},\"breadcrumb\":{\"@id\":\"https://api.pollunit.com/api-reference/options/update-option#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api.pollunit.com/api-reference/options/update-option#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Options\",\"item\":\"https://api.pollunit.com/api-reference/options/list-poll-options\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update option\",\"item\":\"https://api.pollunit.com/api-reference/options/update-option\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api.pollunit.com/api-reference/options/update-option#apireference\",\"headline\":\"Update option\",\"name\":\"Update option\",\"description\":\"Changes an existing option. Only the given attributes are written, the others keep their value. Admin access through the admin_hash may change every option; otherwise the option has to belong to the requesting user and the poll has to still allow changes. Options that already collected votes can only be changed as long as the poll allows it.\",\"url\":\"https://api.pollunit.com/api-reference/options/update-option\",\"mainEntityOfPage\":{\"@id\":\"https://api.pollunit.com/api-reference/options/update-option#webpage\"},\"dateModified\":\"2026-11-16T18:57:55.298Z\",\"publisher\":{\"@id\":\"https://api.pollunit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api.pollunit.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PollUnit\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PollUnit\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/options/update-option.md","siteName":"PollUnit","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Options","pages":[{"title":"List poll options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_id}/options","href":"/api-reference/options/list-poll-options"},{"title":"Create option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/polls/{poll_id}/options","href":"/api-reference/options/create-option"},{"title":"Get option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_id}/options/{id}","href":"/api-reference/options/get-option"},{"title":"Delete option","description":"Removes the option and its child options. Admin access through the admin_hash may delete every option; otherwise the option has to belong to the requesting user, the poll has to still allow changes and the option must not have votes. Options that were paid for through a voting wallet can never be deleted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/polls/{poll_id}/options/{id}","href":"/api-reference/options/delete-option"},{"title":"Update option","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/polls/{poll_id}/options/{id}","href":"/api-reference/options/update-option"}]},{"group":"Polls","pages":[{"title":"List polls","description":"Returns one page of polls, newest first. Use the X-Total-Pages / X-Total-Count response headers to page through the full list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls","href":"/api-reference/polls/list-polls"},{"title":"Create poll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/polls","href":"/api-reference/polls/create-poll"},{"title":"Get poll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_hash}","href":"/api-reference/polls/get-poll"},{"title":"Delete poll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/polls/{poll_hash}","href":"/api-reference/polls/delete-poll"},{"title":"Update poll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/polls/{poll_hash}","href":"/api-reference/polls/update-poll"}]},{"group":"Voters","pages":[{"title":"List poll participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_id}/voters","href":"/api-reference/voters/list-poll-participants"},{"title":"Create participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/polls/{poll_id}/voters","href":"/api-reference/voters/create-participant"},{"title":"Get participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_id}/voters/{id}","href":"/api-reference/voters/get-participant"},{"title":"Delete participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/polls/{poll_id}/voters/{id}","href":"/api-reference/voters/delete-participant"},{"title":"Update participant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/polls/{poll_id}/voters/{id}","href":"/api-reference/voters/update-participant"}]},{"group":"Votes","pages":[{"title":"List poll votes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_id}/votes","href":"/api-reference/votes/list-poll-votes"},{"title":"Create vote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/polls/{poll_id}/votes","href":"/api-reference/votes/create-vote"},{"title":"Get vote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/polls/{poll_id}/votes/{id}","href":"/api-reference/votes/get-vote"},{"title":"Delete vote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/polls/{poll_id}/votes/{id}","href":"/api-reference/votes/delete-vote"},{"title":"Update vote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/polls/{poll_id}/votes/{id}","href":"/api-reference/votes/update-vote"}]}]}]},"basePath":"","title":"Update option - PollUnit","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}