Update an experience or retire it
curl --request PATCH \
--url https://api.dizplai.com/v1/experiences/{experience_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": {
"event_id": "<string>"
},
"locale": "<string>",
"item_order": [
"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9"
],
"status": "deleted"
}
'import requests
url = "https://api.dizplai.com/v1/experiences/{experience_id}"
payload = {
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": { "event_id": "<string>" },
"locale": "<string>",
"item_order": ["pol_01JBX7Q3A1B2C3D4E5F6G7H8J9"],
"status": "deleted"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
metadata: {event_id: '<string>'},
locale: '<string>',
item_order: ['pol_01JBX7Q3A1B2C3D4E5F6G7H8J9'],
status: 'deleted'
})
};
fetch('https://api.dizplai.com/v1/experiences/{experience_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://api.dizplai.com/v1/experiences/{experience_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([
'name' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'metadata' => [
'event_id' => '<string>'
],
'locale' => '<string>',
'item_order' => [
'pol_01JBX7Q3A1B2C3D4E5F6G7H8J9'
],
'status' => 'deleted'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"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/experiences/{experience_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {\n \"event_id\": \"<string>\"\n },\n \"locale\": \"<string>\",\n \"item_order\": [\n \"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9\"\n ],\n \"status\": \"deleted\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.dizplai.com/v1/experiences/{experience_id}")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {\n \"event_id\": \"<string>\"\n },\n \"locale\": \"<string>\",\n \"item_order\": [\n \"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9\"\n ],\n \"status\": \"deleted\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dizplai.com/v1/experiences/{experience_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {\n \"event_id\": \"<string>\"\n },\n \"locale\": \"<string>\",\n \"item_order\": [\n \"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9\"\n ],\n \"status\": \"deleted\"\n}"
response = http.request(request)
puts response.read_body{
"id": "exp_01JBX7Q2T8M4K9R6V3N5P0WZCD",
"name": "<string>",
"status": "scheduled",
"qr_image_url": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": {
"event_id": "<string>"
},
"locale": "<string>",
"items": [
{
"id": "pol_01JBX7Q3A1B2C3D4E5F6G7H8J9",
"name": "<string>",
"experience_id": "exp_01JBX7Q2T8M4K9R6V3N5P0WZCD",
"status": "scheduled",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": {
"event_id": "<string>"
},
"api_version": 2,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "poll",
"results_visibility": "after_vote",
"total_votes": 1,
"final": true,
"requires_sign_in": true,
"question": "<string>",
"options": [
{
"id": "opt_01M7WQND9RKTH6WF72R2VFKZ1S",
"label": "<string>",
"votes": 1,
"percent": 50
}
],
"subtitle": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"hub_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Experiences
Update an experience or retire it
Send only the fields to change. status deleted retires it and every item in it.
PATCH
/
experiences
/
{experience_id}
Update an experience or retire it
curl --request PATCH \
--url https://api.dizplai.com/v1/experiences/{experience_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": {
"event_id": "<string>"
},
"locale": "<string>",
"item_order": [
"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9"
],
"status": "deleted"
}
'import requests
url = "https://api.dizplai.com/v1/experiences/{experience_id}"
payload = {
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": { "event_id": "<string>" },
"locale": "<string>",
"item_order": ["pol_01JBX7Q3A1B2C3D4E5F6G7H8J9"],
"status": "deleted"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
metadata: {event_id: '<string>'},
locale: '<string>',
item_order: ['pol_01JBX7Q3A1B2C3D4E5F6G7H8J9'],
status: 'deleted'
})
};
fetch('https://api.dizplai.com/v1/experiences/{experience_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://api.dizplai.com/v1/experiences/{experience_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([
'name' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'metadata' => [
'event_id' => '<string>'
],
'locale' => '<string>',
'item_order' => [
'pol_01JBX7Q3A1B2C3D4E5F6G7H8J9'
],
'status' => 'deleted'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"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/experiences/{experience_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {\n \"event_id\": \"<string>\"\n },\n \"locale\": \"<string>\",\n \"item_order\": [\n \"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9\"\n ],\n \"status\": \"deleted\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.dizplai.com/v1/experiences/{experience_id}")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {\n \"event_id\": \"<string>\"\n },\n \"locale\": \"<string>\",\n \"item_order\": [\n \"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9\"\n ],\n \"status\": \"deleted\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dizplai.com/v1/experiences/{experience_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {\n \"event_id\": \"<string>\"\n },\n \"locale\": \"<string>\",\n \"item_order\": [\n \"pol_01JBX7Q3A1B2C3D4E5F6G7H8J9\"\n ],\n \"status\": \"deleted\"\n}"
response = http.request(request)
puts response.read_body{
"id": "exp_01JBX7Q2T8M4K9R6V3N5P0WZCD",
"name": "<string>",
"status": "scheduled",
"qr_image_url": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": {
"event_id": "<string>"
},
"locale": "<string>",
"items": [
{
"id": "pol_01JBX7Q3A1B2C3D4E5F6G7H8J9",
"name": "<string>",
"experience_id": "exp_01JBX7Q2T8M4K9R6V3N5P0WZCD",
"status": "scheduled",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"metadata": {
"event_id": "<string>"
},
"api_version": 2,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "poll",
"results_visibility": "after_vote",
"total_votes": 1,
"final": true,
"requires_sign_in": true,
"question": "<string>",
"options": [
{
"id": "opt_01M7WQND9RKTH6WF72R2VFKZ1S",
"label": "<string>",
"votes": 1,
"percent": 50
}
],
"subtitle": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"hub_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Authorizations
Which app is calling, and its usage plan: a platform's secret key, from servers only, or an app's publishable key (pk_live_...), safe in app code. It identifies the app and grants nothing on its own.
A platform's short-lived issuer token, for the same client as the key.
Path Parameters
Pattern:
^exp_[0-9A-HJKMNP-TV-Z]{26}$Example:
"exp_01JBX7Q2T8M4K9R6V3N5P0WZCD"
Body
application/json
The item's name, as the hub card and on-air graphics show it.
Required string length:
1 - 200RFC 3339, in UTC.
RFC 3339, in UTC.
Free-form tags: up to 50 keys of up to 40 characters, values up to 500. One reserved key, event_id: the event the item is about. Every other key is yours, and never interpreted.
Show child attributes
Show child attributes
Every item in the experience, each once, in the order the hub shows them.
Any widget: its type's prefix (pol_, pck_, rtg_, lnp_, prd_, spn_, qiz_ or fzn_) and a 26-character ULID, as on the Dizplai API. Opaque after the prefix.
Pattern:
^(pol|pck|rtg|lnp|prd|spn|qiz|fzn)_[0-9A-HJKMNP-TV-Z]{26}$deleted retires the experience and every item in it. An experience's other statuses come from its items.
Available options:
deleted Response
The experience, as saved.
Pattern:
^exp_[0-9A-HJKMNP-TV-Z]{26}$Example:
"exp_01JBX7Q2T8M4K9R6V3N5P0WZCD"
Worked out from its items: live if any item is, else hidden, else closed.
Available options:
scheduled, live, hidden, closed, deleted The experience's QR code.
Free-form tags: up to 50 keys of up to 40 characters, values up to 500. One reserved key, event_id: the event the item is about. Every other key is yours, and never interpreted.
Show child attributes
Show child attributes
Every item, types mixed, in display order, results included.
Show child attributes
Show child attributes
RFC 3339, in UTC.
RFC 3339, in UTC.
A hub in a creator network: one creator's fan site, registered under the network's client ID. Present only in creator networks; a client without a network has no hub ID.
Pattern:
^hub_[0-9A-HJKMNP-TV-Z]{26}$