Cast a vote

curl --request POST \
  --url https://api.dizplai.com/v1/polls/{poll_id}/votes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c"
}
'

import requests

url = "https://api.dizplai.com/v1/polls/{poll_id}/votes"

payload = { "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({option_id: '01a1f97a-b538-778f-bad7-0c1c35ff701c'})
};

fetch('https://api.dizplai.com/v1/polls/{poll_id}/votes', 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://api.dizplai.com/v1/polls/{poll_id}/votes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'option_id' => '01a1f97a-b538-778f-bad7-0c1c35ff701c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "x-api-key: <api-key>"
  ],
]);

$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://api.dizplai.com/v1/polls/{poll_id}/votes"

	payload := strings.NewReader("{\n  \"option_id\": \"01a1f97a-b538-778f-bad7-0c1c35ff701c\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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.post("https://api.dizplai.com/v1/polls/{poll_id}/votes")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"option_id\": \"01a1f97a-b538-778f-bad7-0c1c35ff701c\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dizplai.com/v1/polls/{poll_id}/votes")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"option_id\": \"01a1f97a-b538-778f-bad7-0c1c35ff701c\"\n}"

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

{
  "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c",
  "results": {
    "state": "live",
    "total_votes": 4211,
    "options": [
      {
        "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c",
        "votes": 2106,
        "percent": 50
      },
      {
        "option_id": "01a1f97a-b5a7-7b5b-9458-203a658c1e8d",
        "votes": 1263,
        "percent": 30
      },
      {
        "option_id": "01a1f97a-b5cc-7fcf-989c-56ebe53808c5",
        "votes": 842,
        "percent": 20
      }
    ]
  }
}

POST

polls

{poll_id}

votes

Cast a vote

curl --request POST \
  --url https://api.dizplai.com/v1/polls/{poll_id}/votes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c"
}
'

import requests

url = "https://api.dizplai.com/v1/polls/{poll_id}/votes"

payload = { "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({option_id: '01a1f97a-b538-778f-bad7-0c1c35ff701c'})
};

fetch('https://api.dizplai.com/v1/polls/{poll_id}/votes', 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://api.dizplai.com/v1/polls/{poll_id}/votes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'option_id' => '01a1f97a-b538-778f-bad7-0c1c35ff701c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "x-api-key: <api-key>"
  ],
]);

$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://api.dizplai.com/v1/polls/{poll_id}/votes"

	payload := strings.NewReader("{\n  \"option_id\": \"01a1f97a-b538-778f-bad7-0c1c35ff701c\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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.post("https://api.dizplai.com/v1/polls/{poll_id}/votes")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"option_id\": \"01a1f97a-b538-778f-bad7-0c1c35ff701c\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dizplai.com/v1/polls/{poll_id}/votes")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"option_id\": \"01a1f97a-b538-778f-bad7-0c1c35ff701c\"\n}"

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

{
  "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c",
  "results": {
    "state": "live",
    "total_votes": 4211,
    "options": [
      {
        "option_id": "01a1f97a-b538-778f-bad7-0c1c35ff701c",
        "votes": 2106,
        "percent": 50
      },
      {
        "option_id": "01a1f97a-b5a7-7b5b-9458-203a658c1e8d",
        "votes": 1263,
        "percent": 30
      },
      {
        "option_id": "01a1f97a-b5cc-7fcf-989c-56ebe53808c5",
        "votes": 842,
        "percent": 20
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

Your organisation's API key, supplied by Dizplai. Send it on every request. It isn't a secret, so it can ship in your app: what a fan does is protected by the fan's token.

Authorization

string

header

required

The fan's token from your own login, sent as Authorization: Bearer <token>: a signed-in fan's or a guest's. Dizplai checks it against your login's details, agreed when you're set up, and a guest's token carries the guest claim agreed at the same time. Needed to vote, upload, send a message, and read the fan's own vote or messages.

Headers

Idempotency-Key

string<uuid>

required

Required. A new UUID for each vote. If the connection drops, send the vote again with the same key: it's never counted twice.

Path Parameters

poll_id

string<uuid>

required

The poll's ID, from a list of experiences or polls. A poll's ID, a UUID.

Example:

"0192fa7b-8d41-7bbc-9b58-02311fc6ef8e"

Body

application/json

A fan's vote, the option they chose.

option_id

string<uuid>

required

One of the poll's options.

Example:

"01a1f97a-b538-778f-bad7-0c1c35ff701c"

Response

Received, not yet counted, with a snapshot of the poll's results that includes the vote. Show the snapshot straight away as a static view: it doesn't update, and a read straight after the vote may not include it yet. For live results, keep reading the poll. A later vote from the same fan also answers 202, with its own snapshot, but is never counted, so retrying after a lost response, with the same Idempotency-Key, is safe. To show the fan's choice on any device, use Get the fan's vote. If the poll closes before a retry, the retry answers not_open, and Get the fan's vote shows whether the first attempt counted.

The vote, received but not yet counted, with a snapshot of the poll's results that includes it.

option_id

string<uuid>

required

The option the fan voted for, as sent.

Example:

"01a1f97a-b538-778f-bad7-0c1c35ff701c"

results

Withheld · object

required

The poll's latest results with this vote added, for a static view straight after the vote. It doesn't update: for live results, keep reading the poll. withheld when fans may not see results yet, as results_visibility says.

Withheld
Counted
Another state

Show child attributes

Using the API

Experiences API

Cast a vote

Authorizations

Headers

Path Parameters

Body

Response