curl --request DELETE \
--url https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card} \
--header 'Authorization: Bearer <token>'import requests
url = "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
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 => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}")
.header("Authorization", "Bearer <token>")
.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::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true,
"overlays": 0,
"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>"
}Take a card off a slide
Remove one card from a slide; everything else on the slide stays. Read the card’s index with get_step.
Needs the decks:write scope.
curl --request DELETE \
--url https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card} \
--header 'Authorization: Bearer <token>'import requests
url = "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
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 => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://test.polltheroom.com/api/v1/decks/{id}/steps/{index}/overlays/{card}")
.header("Authorization", "Bearer <token>")
.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::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true,
"overlays": 0,
"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>"
}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
1The slide step's index
1 <= x <= 9007199254740991The card's index on the slide, counting from 0; read it with get_step
0 <= x <= 9007199254740991Query Parameters
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
^(?:(?:\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
Cards on that slide now
-9007199254740991 <= x <= 9007199254740991Every 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