Update option

curl --request PATCH \
  --url https://pollunit.com/api/v1/polls/{poll_id}/options/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "option": {
    "content": "My option",
    "subtitle": "<string>",
    "description": "<string>",
    "author_name": "<string>",
    "allowed_values": [
      "<string>"
    ],
    "archived": true,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "info_link": "<string>",
    "info_link_title": "<string>",
    "vimeo_id": "<string>",
    "youtube_id": "<string>",
    "attachment": "<string>"
  },
  "parent_option_id": "<string>",
  "additional_attributes": {}
}
'

import requests

url = "https://pollunit.com/api/v1/polls/{poll_id}/options/{id}"

payload = {
    "option": {
        "content": "My option",
        "subtitle": "<string>",
        "description": "<string>",
        "author_name": "<string>",
        "allowed_values": ["<string>"],
        "archived": True,
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "info_link": "<string>",
        "info_link_title": "<string>",
        "vimeo_id": "<string>",
        "youtube_id": "<string>",
        "attachment": "<string>"
    },
    "parent_option_id": "<string>",
    "additional_attributes": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    option: {
      content: 'My option',
      subtitle: '<string>',
      description: '<string>',
      author_name: '<string>',
      allowed_values: ['<string>'],
      archived: true,
      start_date: '2023-11-07T05:31:56Z',
      end_date: '2023-11-07T05:31:56Z',
      info_link: '<string>',
      info_link_title: '<string>',
      vimeo_id: '<string>',
      youtube_id: '<string>',
      attachment: '<string>'
    },
    parent_option_id: '<string>',
    additional_attributes: {}
  })
};

fetch('https://pollunit.com/api/v1/polls/{poll_id}/options/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pollunit.com/api/v1/polls/{poll_id}/options/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'option' => [
        'content' => 'My option',
        'subtitle' => '<string>',
        'description' => '<string>',
        'author_name' => '<string>',
        'allowed_values' => [
                '<string>'
        ],
        'archived' => true,
        'start_date' => '2023-11-07T05:31:56Z',
        'end_date' => '2023-11-07T05:31:56Z',
        'info_link' => '<string>',
        'info_link_title' => '<string>',
        'vimeo_id' => '<string>',
        'youtube_id' => '<string>',
        'attachment' => '<string>'
    ],
    'parent_option_id' => '<string>',
    'additional_attributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pollunit.com/api/v1/polls/{poll_id}/options/{id}"

	payload := strings.NewReader("{\n  \"option\": {\n    \"content\": \"My option\",\n    \"subtitle\": \"<string>\",\n    \"description\": \"<string>\",\n    \"author_name\": \"<string>\",\n    \"allowed_values\": [\n      \"<string>\"\n    ],\n    \"archived\": true,\n    \"start_date\": \"2023-11-07T05:31:56Z\",\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"info_link\": \"<string>\",\n    \"info_link_title\": \"<string>\",\n    \"vimeo_id\": \"<string>\",\n    \"youtube_id\": \"<string>\",\n    \"attachment\": \"<string>\"\n  },\n  \"parent_option_id\": \"<string>\",\n  \"additional_attributes\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://pollunit.com/api/v1/polls/{poll_id}/options/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"option\": {\n    \"content\": \"My option\",\n    \"subtitle\": \"<string>\",\n    \"description\": \"<string>\",\n    \"author_name\": \"<string>\",\n    \"allowed_values\": [\n      \"<string>\"\n    ],\n    \"archived\": true,\n    \"start_date\": \"2023-11-07T05:31:56Z\",\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"info_link\": \"<string>\",\n    \"info_link_title\": \"<string>\",\n    \"vimeo_id\": \"<string>\",\n    \"youtube_id\": \"<string>\",\n    \"attachment\": \"<string>\"\n  },\n  \"parent_option_id\": \"<string>\",\n  \"additional_attributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pollunit.com/api/v1/polls/{poll_id}/options/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"option\": {\n    \"content\": \"My option\",\n    \"subtitle\": \"<string>\",\n    \"description\": \"<string>\",\n    \"author_name\": \"<string>\",\n    \"allowed_values\": [\n      \"<string>\"\n    ],\n    \"archived\": true,\n    \"start_date\": \"2023-11-07T05:31:56Z\",\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"info_link\": \"<string>\",\n    \"info_link_title\": \"<string>\",\n    \"vimeo_id\": \"<string>\",\n    \"youtube_id\": \"<string>\",\n    \"attachment\": \"<string>\"\n  },\n  \"parent_option_id\": \"<string>\",\n  \"additional_attributes\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "public_url": "<string>",
  "type": "Options::TextOption",
  "admin_url": "<string>",
  "parent_option_id": "<string>",
  "content": "<string>",
  "subtitle": "<string>",
  "description": "<string>",
  "author_name": "<string>",
  "position": 123,
  "rank": 123,
  "rating": 123,
  "average_rating": 123,
  "best_rating": true,
  "selected": true,
  "child_option_type": "<string>",
  "data": {},
  "options_count": 123,
  "paid": true,
  "privacy_policy_accepted": true,
  "processing": true,
  "rotation": 123,
  "terms_accepted": true,
  "info_link": "<string>",
  "info_link_title": "<string>",
  "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": "<string>",
  "vimeo_id": "<string>",
  "youtube_id": "<string>",
  "voter_count": 123,
  "settings": {
    "allowed_values": [
      "<string>"
    ],
    "column_width": 123,
    "mandatory": true,
    "multiline": true,
    "randomize_options": true,
    "require_vote": true,
    "show_as_list": true,
    "survey_step_vote_limit_per_option": 123,
    "survey_step_vote_limit_per_option_min": 123,
    "survey_step_vote_limit_per_voter": 123,
    "voter_limit": 123
  },
  "attachment": {
    "attachment_url_large": "<string>",
    "attachment_url_thumb": "<string>",
    "attachment_url_social": "<string>",
    "attachment_url_cover": "<string>",
    "attachment_original_url": "<string>"
  },
  "approval_state_updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "fraudulent_count": 123,
  "state_change_message": "<string>"
}

{
  "error": "Unauthorized"
}

{
  "error": "Not Found"
}

{
  "error": "Unprocessable Entity",
  "errors": {}
}

PATCH

api

polls

{poll_id}

options

{id}

Update option

curl --request PATCH \
  --url https://pollunit.com/api/v1/polls/{poll_id}/options/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "option": {
    "content": "My option",
    "subtitle": "<string>",
    "description": "<string>",
    "author_name": "<string>",
    "allowed_values": [
      "<string>"
    ],
    "archived": true,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "info_link": "<string>",
    "info_link_title": "<string>",
    "vimeo_id": "<string>",
    "youtube_id": "<string>",
    "attachment": "<string>"
  },
  "parent_option_id": "<string>",
  "additional_attributes": {}
}
'

import requests

url = "https://pollunit.com/api/v1/polls/{poll_id}/options/{id}"

payload = {
    "option": {
        "content": "My option",
        "subtitle": "<string>",
        "description": "<string>",
        "author_name": "<string>",
        "allowed_values": ["<string>"],
        "archived": True,
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "info_link": "<string>",
        "info_link_title": "<string>",
        "vimeo_id": "<string>",
        "youtube_id": "<string>",
        "attachment": "<string>"
    },
    "parent_option_id": "<string>",
    "additional_attributes": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    option: {
      content: 'My option',
      subtitle: '<string>',
      description: '<string>',
      author_name: '<string>',
      allowed_values: ['<string>'],
      archived: true,
      start_date: '2023-11-07T05:31:56Z',
      end_date: '2023-11-07T05:31:56Z',
      info_link: '<string>',
      info_link_title: '<string>',
      vimeo_id: '<string>',
      youtube_id: '<string>',
      attachment: '<string>'
    },
    parent_option_id: '<string>',
    additional_attributes: {}
  })
};

fetch('https://pollunit.com/api/v1/polls/{poll_id}/options/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pollunit.com/api/v1/polls/{poll_id}/options/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'option' => [
        'content' => 'My option',
        'subtitle' => '<string>',
        'description' => '<string>',
        'author_name' => '<string>',
        'allowed_values' => [
                '<string>'
        ],
        'archived' => true,
        'start_date' => '2023-11-07T05:31:56Z',
        'end_date' => '2023-11-07T05:31:56Z',
        'info_link' => '<string>',
        'info_link_title' => '<string>',
        'vimeo_id' => '<string>',
        'youtube_id' => '<string>',
        'attachment' => '<string>'
    ],
    'parent_option_id' => '<string>',
    'additional_attributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pollunit.com/api/v1/polls/{poll_id}/options/{id}"

	payload := strings.NewReader("{\n  \"option\": {\n    \"content\": \"My option\",\n    \"subtitle\": \"<string>\",\n    \"description\": \"<string>\",\n    \"author_name\": \"<string>\",\n    \"allowed_values\": [\n      \"<string>\"\n    ],\n    \"archived\": true,\n    \"start_date\": \"2023-11-07T05:31:56Z\",\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"info_link\": \"<string>\",\n    \"info_link_title\": \"<string>\",\n    \"vimeo_id\": \"<string>\",\n    \"youtube_id\": \"<string>\",\n    \"attachment\": \"<string>\"\n  },\n  \"parent_option_id\": \"<string>\",\n  \"additional_attributes\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://pollunit.com/api/v1/polls/{poll_id}/options/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"option\": {\n    \"content\": \"My option\",\n    \"subtitle\": \"<string>\",\n    \"description\": \"<string>\",\n    \"author_name\": \"<string>\",\n    \"allowed_values\": [\n      \"<string>\"\n    ],\n    \"archived\": true,\n    \"start_date\": \"2023-11-07T05:31:56Z\",\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"info_link\": \"<string>\",\n    \"info_link_title\": \"<string>\",\n    \"vimeo_id\": \"<string>\",\n    \"youtube_id\": \"<string>\",\n    \"attachment\": \"<string>\"\n  },\n  \"parent_option_id\": \"<string>\",\n  \"additional_attributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pollunit.com/api/v1/polls/{poll_id}/options/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"option\": {\n    \"content\": \"My option\",\n    \"subtitle\": \"<string>\",\n    \"description\": \"<string>\",\n    \"author_name\": \"<string>\",\n    \"allowed_values\": [\n      \"<string>\"\n    ],\n    \"archived\": true,\n    \"start_date\": \"2023-11-07T05:31:56Z\",\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"info_link\": \"<string>\",\n    \"info_link_title\": \"<string>\",\n    \"vimeo_id\": \"<string>\",\n    \"youtube_id\": \"<string>\",\n    \"attachment\": \"<string>\"\n  },\n  \"parent_option_id\": \"<string>\",\n  \"additional_attributes\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "public_url": "<string>",
  "type": "Options::TextOption",
  "admin_url": "<string>",
  "parent_option_id": "<string>",
  "content": "<string>",
  "subtitle": "<string>",
  "description": "<string>",
  "author_name": "<string>",
  "position": 123,
  "rank": 123,
  "rating": 123,
  "average_rating": 123,
  "best_rating": true,
  "selected": true,
  "child_option_type": "<string>",
  "data": {},
  "options_count": 123,
  "paid": true,
  "privacy_policy_accepted": true,
  "processing": true,
  "rotation": 123,
  "terms_accepted": true,
  "info_link": "<string>",
  "info_link_title": "<string>",
  "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": "<string>",
  "vimeo_id": "<string>",
  "youtube_id": "<string>",
  "voter_count": 123,
  "settings": {
    "allowed_values": [
      "<string>"
    ],
    "column_width": 123,
    "mandatory": true,
    "multiline": true,
    "randomize_options": true,
    "require_vote": true,
    "show_as_list": true,
    "survey_step_vote_limit_per_option": 123,
    "survey_step_vote_limit_per_option_min": 123,
    "survey_step_vote_limit_per_voter": 123,
    "voter_limit": 123
  },
  "attachment": {
    "attachment_url_large": "<string>",
    "attachment_url_thumb": "<string>",
    "attachment_url_social": "<string>",
    "attachment_url_cover": "<string>",
    "attachment_original_url": "<string>"
  },
  "approval_state_updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "fraudulent_count": 123,
  "state_change_message": "<string>"
}

{
  "error": "Unauthorized"
}

{
  "error": "Not Found"
}

{
  "error": "Unprocessable Entity",
  "errors": {}
}

Authorizations

Authorization

string

header

required

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

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

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.

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

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

start_date

string<date-time> | null

end_date

string<date-time> | null

created_at

string<date-time> | null

updated_at

string<date-time> | null

vimeo_id

string | null

youtube_id

string | null

voter_count

integer | null

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