Change a card
curl --request PATCH \
--url https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"poll": {
"prompt": "<string>",
"timeLimitSec": 302,
"options": [
"<string>"
],
"multiSelect": true,
"correctIndex": 4,
"optionImages": [
"<string>"
],
"groups": [
"<string>"
],
"targets": [
50
],
"estimateMin": 123,
"estimateMax": 123,
"answer": 123,
"dimensions": [
"<string>"
],
"moderated": true,
"wheelNames": [
"<string>"
],
"refs": [
99
],
"accent": "<string>",
"optionColors": [
"<string>"
],
"showPercent": true,
"showCount": true
},
"style": {
"variant": "bars",
"accent": "#3B82F6",
"background": "#FFFFFF",
"radius": 14,
"shadow": true,
"outline": false,
"outlineColor": "#E4E4E8",
"showPercent": true,
"showCount": true,
"showJoin": true,
"rotation": 0,
"optionColors": [
"<string>"
],
"showTitle": true,
"titleFont": "<string>",
"titleSize": 10.5,
"titleColor": "<string>",
"titleBold": true,
"textFont": "<string>"
},
"revision": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
payload = {
"poll": {
"prompt": "<string>",
"timeLimitSec": 302,
"options": ["<string>"],
"multiSelect": True,
"correctIndex": 4,
"optionImages": ["<string>"],
"groups": ["<string>"],
"targets": [50],
"estimateMin": 123,
"estimateMax": 123,
"answer": 123,
"dimensions": ["<string>"],
"moderated": True,
"wheelNames": ["<string>"],
"refs": [99],
"accent": "<string>",
"optionColors": ["<string>"],
"showPercent": True,
"showCount": True
},
"style": {
"variant": "bars",
"accent": "#3B82F6",
"background": "#FFFFFF",
"radius": 14,
"shadow": True,
"outline": False,
"outlineColor": "#E4E4E8",
"showPercent": True,
"showCount": True,
"showJoin": True,
"rotation": 0,
"optionColors": ["<string>"],
"showTitle": True,
"titleFont": "<string>",
"titleSize": 10.5,
"titleColor": "<string>",
"titleBold": True,
"textFont": "<string>"
},
"revision": "2023-11-07T05:31:56Z"
}
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({
poll: {
prompt: '<string>',
timeLimitSec: 302,
options: ['<string>'],
multiSelect: true,
correctIndex: 4,
optionImages: ['<string>'],
groups: ['<string>'],
targets: [50],
estimateMin: 123,
estimateMax: 123,
answer: 123,
dimensions: ['<string>'],
moderated: true,
wheelNames: ['<string>'],
refs: [99],
accent: '<string>',
optionColors: ['<string>'],
showPercent: true,
showCount: true
},
style: {
variant: 'bars',
accent: '#3B82F6',
background: '#FFFFFF',
radius: 14,
shadow: true,
outline: false,
outlineColor: '#E4E4E8',
showPercent: true,
showCount: true,
showJoin: true,
rotation: 0,
optionColors: ['<string>'],
showTitle: true,
titleFont: '<string>',
titleSize: 10.5,
titleColor: '<string>',
titleBold: true,
textFont: '<string>'
},
revision: '2023-11-07T05:31:56Z'
})
};
fetch('https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}', 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://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}",
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([
'poll' => [
'prompt' => '<string>',
'timeLimitSec' => 302,
'options' => [
'<string>'
],
'multiSelect' => true,
'correctIndex' => 4,
'optionImages' => [
'<string>'
],
'groups' => [
'<string>'
],
'targets' => [
50
],
'estimateMin' => 123,
'estimateMax' => 123,
'answer' => 123,
'dimensions' => [
'<string>'
],
'moderated' => true,
'wheelNames' => [
'<string>'
],
'refs' => [
99
],
'accent' => '<string>',
'optionColors' => [
'<string>'
],
'showPercent' => true,
'showCount' => true
],
'style' => [
'variant' => 'bars',
'accent' => '#3B82F6',
'background' => '#FFFFFF',
'radius' => 14,
'shadow' => true,
'outline' => false,
'outlineColor' => '#E4E4E8',
'showPercent' => true,
'showCount' => true,
'showJoin' => true,
'rotation' => 0,
'optionColors' => [
'<string>'
],
'showTitle' => true,
'titleFont' => '<string>',
'titleSize' => 10.5,
'titleColor' => '<string>',
'titleBold' => true,
'textFont' => '<string>'
],
'revision' => '2023-11-07T05:31:56Z'
]),
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://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
payload := strings.NewReader("{\n \"poll\": {\n \"prompt\": \"<string>\",\n \"timeLimitSec\": 302,\n \"options\": [\n \"<string>\"\n ],\n \"multiSelect\": true,\n \"correctIndex\": 4,\n \"optionImages\": [\n \"<string>\"\n ],\n \"groups\": [\n \"<string>\"\n ],\n \"targets\": [\n 50\n ],\n \"estimateMin\": 123,\n \"estimateMax\": 123,\n \"answer\": 123,\n \"dimensions\": [\n \"<string>\"\n ],\n \"moderated\": true,\n \"wheelNames\": [\n \"<string>\"\n ],\n \"refs\": [\n 99\n ],\n \"accent\": \"<string>\",\n \"optionColors\": [\n \"<string>\"\n ],\n \"showPercent\": true,\n \"showCount\": true\n },\n \"style\": {\n \"variant\": \"bars\",\n \"accent\": \"#3B82F6\",\n \"background\": \"#FFFFFF\",\n \"radius\": 14,\n \"shadow\": true,\n \"outline\": false,\n \"outlineColor\": \"#E4E4E8\",\n \"showPercent\": true,\n \"showCount\": true,\n \"showJoin\": true,\n \"rotation\": 0,\n \"optionColors\": [\n \"<string>\"\n ],\n \"showTitle\": true,\n \"titleFont\": \"<string>\",\n \"titleSize\": 10.5,\n \"titleColor\": \"<string>\",\n \"titleBold\": true,\n \"textFont\": \"<string>\"\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\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://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"poll\": {\n \"prompt\": \"<string>\",\n \"timeLimitSec\": 302,\n \"options\": [\n \"<string>\"\n ],\n \"multiSelect\": true,\n \"correctIndex\": 4,\n \"optionImages\": [\n \"<string>\"\n ],\n \"groups\": [\n \"<string>\"\n ],\n \"targets\": [\n 50\n ],\n \"estimateMin\": 123,\n \"estimateMax\": 123,\n \"answer\": 123,\n \"dimensions\": [\n \"<string>\"\n ],\n \"moderated\": true,\n \"wheelNames\": [\n \"<string>\"\n ],\n \"refs\": [\n 99\n ],\n \"accent\": \"<string>\",\n \"optionColors\": [\n \"<string>\"\n ],\n \"showPercent\": true,\n \"showCount\": true\n },\n \"style\": {\n \"variant\": \"bars\",\n \"accent\": \"#3B82F6\",\n \"background\": \"#FFFFFF\",\n \"radius\": 14,\n \"shadow\": true,\n \"outline\": false,\n \"outlineColor\": \"#E4E4E8\",\n \"showPercent\": true,\n \"showCount\": true,\n \"showJoin\": true,\n \"rotation\": 0,\n \"optionColors\": [\n \"<string>\"\n ],\n \"showTitle\": true,\n \"titleFont\": \"<string>\",\n \"titleSize\": 10.5,\n \"titleColor\": \"<string>\",\n \"titleBold\": true,\n \"textFont\": \"<string>\"\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}")
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 \"poll\": {\n \"prompt\": \"<string>\",\n \"timeLimitSec\": 302,\n \"options\": [\n \"<string>\"\n ],\n \"multiSelect\": true,\n \"correctIndex\": 4,\n \"optionImages\": [\n \"<string>\"\n ],\n \"groups\": [\n \"<string>\"\n ],\n \"targets\": [\n 50\n ],\n \"estimateMin\": 123,\n \"estimateMax\": 123,\n \"answer\": 123,\n \"dimensions\": [\n \"<string>\"\n ],\n \"moderated\": true,\n \"wheelNames\": [\n \"<string>\"\n ],\n \"refs\": [\n 99\n ],\n \"accent\": \"<string>\",\n \"optionColors\": [\n \"<string>\"\n ],\n \"showPercent\": true,\n \"showCount\": true\n },\n \"style\": {\n \"variant\": \"bars\",\n \"accent\": \"#3B82F6\",\n \"background\": \"#FFFFFF\",\n \"radius\": 14,\n \"shadow\": true,\n \"outline\": false,\n \"outlineColor\": \"#E4E4E8\",\n \"showPercent\": true,\n \"showCount\": true,\n \"showJoin\": true,\n \"rotation\": 0,\n \"optionColors\": [\n \"<string>\"\n ],\n \"showTitle\": true,\n \"titleFont\": \"<string>\",\n \"titleSize\": 10.5,\n \"titleColor\": \"<string>\",\n \"titleBold\": true,\n \"textFont\": \"<string>\"\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"card": {
"id": "<string>",
"poll": {
"type": "multiple-choice",
"prompt": "<string>",
"timeLimitSec": 302,
"options": [],
"multiSelect": true,
"correctIndex": 4,
"quizView": "question",
"optionImages": [
"<string>"
],
"groups": [
"<string>"
],
"targets": [
50
],
"estimateMin": 123,
"estimateMax": 123,
"answer": 123,
"dimensions": [
"<string>"
],
"moderated": true,
"wheelSource": "participants",
"wheelNames": [
"<string>"
],
"place": {
"label": "<string>",
"lat": 0,
"lon": 0,
"zoom": 10
},
"placeTheme": "standard",
"refs": [
99
],
"accent": "<string>",
"colorMode": "match",
"optionColors": [
"<string>"
],
"showPercent": true,
"showCount": true,
"mcStyle": "bars",
"imgStyle": "tiles",
"totStyle": "split",
"rankStyle": "list",
"hpStyle": "bars",
"scaleStyle": "stars",
"npsStyle": "score",
"estStyle": "hist",
"wcStyle": "cloud",
"ofStyle": "feed",
"qaStyle": "list",
"mapStyle": "pins",
"roundsMode": "bump"
},
"rect": {
"x": 0.6,
"y": 0.52,
"w": 0.36,
"h": 0.42
},
"style": {
"variant": "bars",
"accent": "#3B82F6",
"background": "#FFFFFF",
"radius": 14,
"shadow": true,
"outline": false,
"outlineColor": "#E4E4E8",
"showPercent": true,
"showCount": true,
"showJoin": true,
"rotation": 0,
"colorMode": "match",
"optionColors": [
"<string>"
],
"showTitle": true,
"titleFont": "<string>",
"titleSize": 10.5,
"titleColor": "<string>",
"titleBold": true,
"titleAlign": "left",
"textFont": "<string>"
},
"locked": false,
"z": 123,
"prevRect": {
"x": 0.5,
"y": 0.5,
"w": 0.51,
"h": 0.51
}
},
"ready": true,
"problems": [
{
"step": 0,
"path": "<string>",
"message": "<string>",
"overlay": 0
}
],
"warnings": [
{
"element": "<string>",
"message": "<string>",
"step": 0,
"with": "<string>"
}
],
"revision": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}decks
Change a card
Change one card on a slide without resending the slide: the poll, where it sits (rect) or how it is drawn (style), each merged over what is there; what you leave out stays. Read the card’s index with get_step. The way Paper’s update_styles and move_nodes act on one node.
Needs the decks:write scope.
PATCH
/
api
/
v1
/
decks
/
{id}
/
steps
/
{index}
/
overlays
/
{card}
Change a card
curl --request PATCH \
--url https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"poll": {
"prompt": "<string>",
"timeLimitSec": 302,
"options": [
"<string>"
],
"multiSelect": true,
"correctIndex": 4,
"optionImages": [
"<string>"
],
"groups": [
"<string>"
],
"targets": [
50
],
"estimateMin": 123,
"estimateMax": 123,
"answer": 123,
"dimensions": [
"<string>"
],
"moderated": true,
"wheelNames": [
"<string>"
],
"refs": [
99
],
"accent": "<string>",
"optionColors": [
"<string>"
],
"showPercent": true,
"showCount": true
},
"style": {
"variant": "bars",
"accent": "#3B82F6",
"background": "#FFFFFF",
"radius": 14,
"shadow": true,
"outline": false,
"outlineColor": "#E4E4E8",
"showPercent": true,
"showCount": true,
"showJoin": true,
"rotation": 0,
"optionColors": [
"<string>"
],
"showTitle": true,
"titleFont": "<string>",
"titleSize": 10.5,
"titleColor": "<string>",
"titleBold": true,
"textFont": "<string>"
},
"revision": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
payload = {
"poll": {
"prompt": "<string>",
"timeLimitSec": 302,
"options": ["<string>"],
"multiSelect": True,
"correctIndex": 4,
"optionImages": ["<string>"],
"groups": ["<string>"],
"targets": [50],
"estimateMin": 123,
"estimateMax": 123,
"answer": 123,
"dimensions": ["<string>"],
"moderated": True,
"wheelNames": ["<string>"],
"refs": [99],
"accent": "<string>",
"optionColors": ["<string>"],
"showPercent": True,
"showCount": True
},
"style": {
"variant": "bars",
"accent": "#3B82F6",
"background": "#FFFFFF",
"radius": 14,
"shadow": True,
"outline": False,
"outlineColor": "#E4E4E8",
"showPercent": True,
"showCount": True,
"showJoin": True,
"rotation": 0,
"optionColors": ["<string>"],
"showTitle": True,
"titleFont": "<string>",
"titleSize": 10.5,
"titleColor": "<string>",
"titleBold": True,
"textFont": "<string>"
},
"revision": "2023-11-07T05:31:56Z"
}
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({
poll: {
prompt: '<string>',
timeLimitSec: 302,
options: ['<string>'],
multiSelect: true,
correctIndex: 4,
optionImages: ['<string>'],
groups: ['<string>'],
targets: [50],
estimateMin: 123,
estimateMax: 123,
answer: 123,
dimensions: ['<string>'],
moderated: true,
wheelNames: ['<string>'],
refs: [99],
accent: '<string>',
optionColors: ['<string>'],
showPercent: true,
showCount: true
},
style: {
variant: 'bars',
accent: '#3B82F6',
background: '#FFFFFF',
radius: 14,
shadow: true,
outline: false,
outlineColor: '#E4E4E8',
showPercent: true,
showCount: true,
showJoin: true,
rotation: 0,
optionColors: ['<string>'],
showTitle: true,
titleFont: '<string>',
titleSize: 10.5,
titleColor: '<string>',
titleBold: true,
textFont: '<string>'
},
revision: '2023-11-07T05:31:56Z'
})
};
fetch('https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}', 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://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}",
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([
'poll' => [
'prompt' => '<string>',
'timeLimitSec' => 302,
'options' => [
'<string>'
],
'multiSelect' => true,
'correctIndex' => 4,
'optionImages' => [
'<string>'
],
'groups' => [
'<string>'
],
'targets' => [
50
],
'estimateMin' => 123,
'estimateMax' => 123,
'answer' => 123,
'dimensions' => [
'<string>'
],
'moderated' => true,
'wheelNames' => [
'<string>'
],
'refs' => [
99
],
'accent' => '<string>',
'optionColors' => [
'<string>'
],
'showPercent' => true,
'showCount' => true
],
'style' => [
'variant' => 'bars',
'accent' => '#3B82F6',
'background' => '#FFFFFF',
'radius' => 14,
'shadow' => true,
'outline' => false,
'outlineColor' => '#E4E4E8',
'showPercent' => true,
'showCount' => true,
'showJoin' => true,
'rotation' => 0,
'optionColors' => [
'<string>'
],
'showTitle' => true,
'titleFont' => '<string>',
'titleSize' => 10.5,
'titleColor' => '<string>',
'titleBold' => true,
'textFont' => '<string>'
],
'revision' => '2023-11-07T05:31:56Z'
]),
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://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
payload := strings.NewReader("{\n \"poll\": {\n \"prompt\": \"<string>\",\n \"timeLimitSec\": 302,\n \"options\": [\n \"<string>\"\n ],\n \"multiSelect\": true,\n \"correctIndex\": 4,\n \"optionImages\": [\n \"<string>\"\n ],\n \"groups\": [\n \"<string>\"\n ],\n \"targets\": [\n 50\n ],\n \"estimateMin\": 123,\n \"estimateMax\": 123,\n \"answer\": 123,\n \"dimensions\": [\n \"<string>\"\n ],\n \"moderated\": true,\n \"wheelNames\": [\n \"<string>\"\n ],\n \"refs\": [\n 99\n ],\n \"accent\": \"<string>\",\n \"optionColors\": [\n \"<string>\"\n ],\n \"showPercent\": true,\n \"showCount\": true\n },\n \"style\": {\n \"variant\": \"bars\",\n \"accent\": \"#3B82F6\",\n \"background\": \"#FFFFFF\",\n \"radius\": 14,\n \"shadow\": true,\n \"outline\": false,\n \"outlineColor\": \"#E4E4E8\",\n \"showPercent\": true,\n \"showCount\": true,\n \"showJoin\": true,\n \"rotation\": 0,\n \"optionColors\": [\n \"<string>\"\n ],\n \"showTitle\": true,\n \"titleFont\": \"<string>\",\n \"titleSize\": 10.5,\n \"titleColor\": \"<string>\",\n \"titleBold\": true,\n \"textFont\": \"<string>\"\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\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://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"poll\": {\n \"prompt\": \"<string>\",\n \"timeLimitSec\": 302,\n \"options\": [\n \"<string>\"\n ],\n \"multiSelect\": true,\n \"correctIndex\": 4,\n \"optionImages\": [\n \"<string>\"\n ],\n \"groups\": [\n \"<string>\"\n ],\n \"targets\": [\n 50\n ],\n \"estimateMin\": 123,\n \"estimateMax\": 123,\n \"answer\": 123,\n \"dimensions\": [\n \"<string>\"\n ],\n \"moderated\": true,\n \"wheelNames\": [\n \"<string>\"\n ],\n \"refs\": [\n 99\n ],\n \"accent\": \"<string>\",\n \"optionColors\": [\n \"<string>\"\n ],\n \"showPercent\": true,\n \"showCount\": true\n },\n \"style\": {\n \"variant\": \"bars\",\n \"accent\": \"#3B82F6\",\n \"background\": \"#FFFFFF\",\n \"radius\": 14,\n \"shadow\": true,\n \"outline\": false,\n \"outlineColor\": \"#E4E4E8\",\n \"showPercent\": true,\n \"showCount\": true,\n \"showJoin\": true,\n \"rotation\": 0,\n \"optionColors\": [\n \"<string>\"\n ],\n \"showTitle\": true,\n \"titleFont\": \"<string>\",\n \"titleSize\": 10.5,\n \"titleColor\": \"<string>\",\n \"titleBold\": true,\n \"textFont\": \"<string>\"\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}")
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 \"poll\": {\n \"prompt\": \"<string>\",\n \"timeLimitSec\": 302,\n \"options\": [\n \"<string>\"\n ],\n \"multiSelect\": true,\n \"correctIndex\": 4,\n \"optionImages\": [\n \"<string>\"\n ],\n \"groups\": [\n \"<string>\"\n ],\n \"targets\": [\n 50\n ],\n \"estimateMin\": 123,\n \"estimateMax\": 123,\n \"answer\": 123,\n \"dimensions\": [\n \"<string>\"\n ],\n \"moderated\": true,\n \"wheelNames\": [\n \"<string>\"\n ],\n \"refs\": [\n 99\n ],\n \"accent\": \"<string>\",\n \"optionColors\": [\n \"<string>\"\n ],\n \"showPercent\": true,\n \"showCount\": true\n },\n \"style\": {\n \"variant\": \"bars\",\n \"accent\": \"#3B82F6\",\n \"background\": \"#FFFFFF\",\n \"radius\": 14,\n \"shadow\": true,\n \"outline\": false,\n \"outlineColor\": \"#E4E4E8\",\n \"showPercent\": true,\n \"showCount\": true,\n \"showJoin\": true,\n \"rotation\": 0,\n \"optionColors\": [\n \"<string>\"\n ],\n \"showTitle\": true,\n \"titleFont\": \"<string>\",\n \"titleSize\": 10.5,\n \"titleColor\": \"<string>\",\n \"titleBold\": true,\n \"textFont\": \"<string>\"\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"card": {
"id": "<string>",
"poll": {
"type": "multiple-choice",
"prompt": "<string>",
"timeLimitSec": 302,
"options": [],
"multiSelect": true,
"correctIndex": 4,
"quizView": "question",
"optionImages": [
"<string>"
],
"groups": [
"<string>"
],
"targets": [
50
],
"estimateMin": 123,
"estimateMax": 123,
"answer": 123,
"dimensions": [
"<string>"
],
"moderated": true,
"wheelSource": "participants",
"wheelNames": [
"<string>"
],
"place": {
"label": "<string>",
"lat": 0,
"lon": 0,
"zoom": 10
},
"placeTheme": "standard",
"refs": [
99
],
"accent": "<string>",
"colorMode": "match",
"optionColors": [
"<string>"
],
"showPercent": true,
"showCount": true,
"mcStyle": "bars",
"imgStyle": "tiles",
"totStyle": "split",
"rankStyle": "list",
"hpStyle": "bars",
"scaleStyle": "stars",
"npsStyle": "score",
"estStyle": "hist",
"wcStyle": "cloud",
"ofStyle": "feed",
"qaStyle": "list",
"mapStyle": "pins",
"roundsMode": "bump"
},
"rect": {
"x": 0.6,
"y": 0.52,
"w": 0.36,
"h": 0.42
},
"style": {
"variant": "bars",
"accent": "#3B82F6",
"background": "#FFFFFF",
"radius": 14,
"shadow": true,
"outline": false,
"outlineColor": "#E4E4E8",
"showPercent": true,
"showCount": true,
"showJoin": true,
"rotation": 0,
"colorMode": "match",
"optionColors": [
"<string>"
],
"showTitle": true,
"titleFont": "<string>",
"titleSize": 10.5,
"titleColor": "<string>",
"titleBold": true,
"titleAlign": "left",
"textFont": "<string>"
},
"locked": false,
"z": 123,
"prevRect": {
"x": 0.5,
"y": 0.5,
"w": 0.51,
"h": 0.51
}
},
"ready": true,
"problems": [
{
"step": 0,
"path": "<string>",
"message": "<string>",
"overlay": 0
}
],
"warnings": [
{
"element": "<string>",
"message": "<string>",
"step": 0,
"with": "<string>"
}
],
"revision": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}Authorizations
An API key from Settings › API, sent as Authorization: Bearer ptr_…. Shown once when made; only a hash is stored.
Path Parameters
The deck's id
Minimum string length:
1The slide step's index
Required range:
1 <= x <= 9007199254740991The card's index on the slide, counting from 0; read it with get_step
Required range:
0 <= x <= 9007199254740991Body
application/json
Poll properties to change; the rest stay
Show child attributes
Show child attributes
Where the card sits now
Show child attributes
Show child attributes
Style properties to change; the rest stay
Show child attributes
Show child attributes
The deck's revision you read (from get_deck or the last write). Sent, the write lands only if nobody changed the deck since; left out, it goes through regardless
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
OK
The card as it is now
Show child attributes
Show child attributes
Every poll passes the readiness check, so a room can start
What stops it, by step; empty when ready
Show child attributes
Show child attributes
Placements that will not read well on stage, by step: a card smaller than a fifth of the slide either way, or a card or text box over another card or text box. They do not stop a room; fix them anyway
Show child attributes
Show child attributes
The deck's revision after this write; send it as revision with the next write to be sure nobody changed the deck in between