Change text, a shape or a picture
curl --request PATCH \
--url https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/elements/{kind}/{element} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": {
"id": "<string>",
"text": "<string>",
"z": 123,
"style": {
"size": 10.5,
"color": "<string>",
"bold": true,
"font": "<string>"
}
},
"shape": {
"id": "<string>",
"z": 123,
"style": {
"fill": "<string>",
"opacity": 0.525,
"radius": 24,
"shadow": true,
"outline": true,
"outlineColor": "<string>"
}
},
"image": {
"id": "<string>",
"z": 123,
"dataUrl": "<string>",
"shadow": true,
"outline": true,
"outlineColor": "<string>",
"radius": 24
},
"revision": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}"
payload = {
"text": {
"id": "<string>",
"text": "<string>",
"z": 123,
"style": {
"size": 10.5,
"color": "<string>",
"bold": True,
"font": "<string>"
}
},
"shape": {
"id": "<string>",
"z": 123,
"style": {
"fill": "<string>",
"opacity": 0.525,
"radius": 24,
"shadow": True,
"outline": True,
"outlineColor": "<string>"
}
},
"image": {
"id": "<string>",
"z": 123,
"dataUrl": "<string>",
"shadow": True,
"outline": True,
"outlineColor": "<string>",
"radius": 24
},
"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({
text: {
id: '<string>',
text: '<string>',
z: 123,
style: {size: 10.5, color: '<string>', bold: true, font: '<string>'}
},
shape: {
id: '<string>',
z: 123,
style: {
fill: '<string>',
opacity: 0.525,
radius: 24,
shadow: true,
outline: true,
outlineColor: '<string>'
}
},
image: {
id: '<string>',
z: 123,
dataUrl: '<string>',
shadow: true,
outline: true,
outlineColor: '<string>',
radius: 24
},
revision: '2023-11-07T05:31:56Z'
})
};
fetch('https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}', 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}/elements/{kind}/{element}",
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([
'text' => [
'id' => '<string>',
'text' => '<string>',
'z' => 123,
'style' => [
'size' => 10.5,
'color' => '<string>',
'bold' => true,
'font' => '<string>'
]
],
'shape' => [
'id' => '<string>',
'z' => 123,
'style' => [
'fill' => '<string>',
'opacity' => 0.525,
'radius' => 24,
'shadow' => true,
'outline' => true,
'outlineColor' => '<string>'
]
],
'image' => [
'id' => '<string>',
'z' => 123,
'dataUrl' => '<string>',
'shadow' => true,
'outline' => true,
'outlineColor' => '<string>',
'radius' => 24
],
'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}/elements/{kind}/{element}"
payload := strings.NewReader("{\n \"text\": {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"size\": 10.5,\n \"color\": \"<string>\",\n \"bold\": true,\n \"font\": \"<string>\"\n }\n },\n \"shape\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"fill\": \"<string>\",\n \"opacity\": 0.525,\n \"radius\": 24,\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\"\n }\n },\n \"image\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"dataUrl\": \"<string>\",\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\",\n \"radius\": 24\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}/elements/{kind}/{element}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"size\": 10.5,\n \"color\": \"<string>\",\n \"bold\": true,\n \"font\": \"<string>\"\n }\n },\n \"shape\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"fill\": \"<string>\",\n \"opacity\": 0.525,\n \"radius\": 24,\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\"\n }\n },\n \"image\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"dataUrl\": \"<string>\",\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\",\n \"radius\": 24\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}/elements/{kind}/{element}")
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 \"text\": {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"size\": 10.5,\n \"color\": \"<string>\",\n \"bold\": true,\n \"font\": \"<string>\"\n }\n },\n \"shape\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"fill\": \"<string>\",\n \"opacity\": 0.525,\n \"radius\": 24,\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\"\n }\n },\n \"image\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"dataUrl\": \"<string>\",\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\",\n \"radius\": 24\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"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 text, a shape or a picture
Change one text box, shape or image on a slide: send the properties to change under text, shape or image (matching the kind in the path); they are merged over what is there, style included, and what you leave out stays. Read the element’s index with get_step.
Needs the decks:write scope.
PATCH
/
api
/
v1
/
decks
/
{id}
/
steps
/
{index}
/
elements
/
{kind}
/
{element}
Change text, a shape or a picture
curl --request PATCH \
--url https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/elements/{kind}/{element} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": {
"id": "<string>",
"text": "<string>",
"z": 123,
"style": {
"size": 10.5,
"color": "<string>",
"bold": true,
"font": "<string>"
}
},
"shape": {
"id": "<string>",
"z": 123,
"style": {
"fill": "<string>",
"opacity": 0.525,
"radius": 24,
"shadow": true,
"outline": true,
"outlineColor": "<string>"
}
},
"image": {
"id": "<string>",
"z": 123,
"dataUrl": "<string>",
"shadow": true,
"outline": true,
"outlineColor": "<string>",
"radius": 24
},
"revision": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}"
payload = {
"text": {
"id": "<string>",
"text": "<string>",
"z": 123,
"style": {
"size": 10.5,
"color": "<string>",
"bold": True,
"font": "<string>"
}
},
"shape": {
"id": "<string>",
"z": 123,
"style": {
"fill": "<string>",
"opacity": 0.525,
"radius": 24,
"shadow": True,
"outline": True,
"outlineColor": "<string>"
}
},
"image": {
"id": "<string>",
"z": 123,
"dataUrl": "<string>",
"shadow": True,
"outline": True,
"outlineColor": "<string>",
"radius": 24
},
"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({
text: {
id: '<string>',
text: '<string>',
z: 123,
style: {size: 10.5, color: '<string>', bold: true, font: '<string>'}
},
shape: {
id: '<string>',
z: 123,
style: {
fill: '<string>',
opacity: 0.525,
radius: 24,
shadow: true,
outline: true,
outlineColor: '<string>'
}
},
image: {
id: '<string>',
z: 123,
dataUrl: '<string>',
shadow: true,
outline: true,
outlineColor: '<string>',
radius: 24
},
revision: '2023-11-07T05:31:56Z'
})
};
fetch('https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}', 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}/elements/{kind}/{element}",
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([
'text' => [
'id' => '<string>',
'text' => '<string>',
'z' => 123,
'style' => [
'size' => 10.5,
'color' => '<string>',
'bold' => true,
'font' => '<string>'
]
],
'shape' => [
'id' => '<string>',
'z' => 123,
'style' => [
'fill' => '<string>',
'opacity' => 0.525,
'radius' => 24,
'shadow' => true,
'outline' => true,
'outlineColor' => '<string>'
]
],
'image' => [
'id' => '<string>',
'z' => 123,
'dataUrl' => '<string>',
'shadow' => true,
'outline' => true,
'outlineColor' => '<string>',
'radius' => 24
],
'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}/elements/{kind}/{element}"
payload := strings.NewReader("{\n \"text\": {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"size\": 10.5,\n \"color\": \"<string>\",\n \"bold\": true,\n \"font\": \"<string>\"\n }\n },\n \"shape\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"fill\": \"<string>\",\n \"opacity\": 0.525,\n \"radius\": 24,\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\"\n }\n },\n \"image\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"dataUrl\": \"<string>\",\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\",\n \"radius\": 24\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}/elements/{kind}/{element}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"size\": 10.5,\n \"color\": \"<string>\",\n \"bold\": true,\n \"font\": \"<string>\"\n }\n },\n \"shape\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"fill\": \"<string>\",\n \"opacity\": 0.525,\n \"radius\": 24,\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\"\n }\n },\n \"image\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"dataUrl\": \"<string>\",\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\",\n \"radius\": 24\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}/elements/{kind}/{element}")
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 \"text\": {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"size\": 10.5,\n \"color\": \"<string>\",\n \"bold\": true,\n \"font\": \"<string>\"\n }\n },\n \"shape\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"style\": {\n \"fill\": \"<string>\",\n \"opacity\": 0.525,\n \"radius\": 24,\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\"\n }\n },\n \"image\": {\n \"id\": \"<string>\",\n \"z\": 123,\n \"dataUrl\": \"<string>\",\n \"shadow\": true,\n \"outline\": true,\n \"outlineColor\": \"<string>\",\n \"radius\": 24\n },\n \"revision\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"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 <= 9007199254740991Available options:
text, shape, image The element's index in its list, counting from 0
Required range:
0 <= x <= 9007199254740991Body
application/json
For a text box: the properties to change
Show child attributes
Show child attributes
For a shape: the properties to change
Show child attributes
Show child attributes
For an image: the properties to change
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
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