Create Session
curl --request POST \
--url https://api.series.hr/sessions/create \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"Title": "Training Session",
"Scheduled": "2023-11-07T05:31:56Z",
"Duration": 2,
"Description": "<string>",
"Host": "714760171",
"CoHost": "<string>",
"Supervisor": "<string>",
"Claimable": true,
"CustomRoles": [
{
"name": "<string>",
"slots": 5,
"minRank": 1,
"permissions": {
"ChangeSessionStatus": true,
"PassOrFailAttendees": true,
"ModifyAttendance": true
}
}
]
}
'import requests
url = "https://api.series.hr/sessions/create"
payload = {
"Title": "Training Session",
"Scheduled": "2023-11-07T05:31:56Z",
"Duration": 2,
"Description": "<string>",
"Host": "714760171",
"CoHost": "<string>",
"Supervisor": "<string>",
"Claimable": True,
"CustomRoles": [
{
"name": "<string>",
"slots": 5,
"minRank": 1,
"permissions": {
"ChangeSessionStatus": True,
"PassOrFailAttendees": True,
"ModifyAttendance": True
}
}
]
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Title: 'Training Session',
Scheduled: '2023-11-07T05:31:56Z',
Duration: 2,
Description: '<string>',
Host: '714760171',
CoHost: '<string>',
Supervisor: '<string>',
Claimable: true,
CustomRoles: [
{
name: '<string>',
slots: 5,
minRank: 1,
permissions: {ChangeSessionStatus: true, PassOrFailAttendees: true, ModifyAttendance: true}
}
]
})
};
fetch('https://api.series.hr/sessions/create', 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.series.hr/sessions/create",
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([
'Title' => 'Training Session',
'Scheduled' => '2023-11-07T05:31:56Z',
'Duration' => 2,
'Description' => '<string>',
'Host' => '714760171',
'CoHost' => '<string>',
'Supervisor' => '<string>',
'Claimable' => true,
'CustomRoles' => [
[
'name' => '<string>',
'slots' => 5,
'minRank' => 1,
'permissions' => [
'ChangeSessionStatus' => true,
'PassOrFailAttendees' => true,
'ModifyAttendance' => true
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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.series.hr/sessions/create"
payload := strings.NewReader("{\n \"Title\": \"Training Session\",\n \"Scheduled\": \"2023-11-07T05:31:56Z\",\n \"Duration\": 2,\n \"Description\": \"<string>\",\n \"Host\": \"714760171\",\n \"CoHost\": \"<string>\",\n \"Supervisor\": \"<string>\",\n \"Claimable\": true,\n \"CustomRoles\": [\n {\n \"name\": \"<string>\",\n \"slots\": 5,\n \"minRank\": 1,\n \"permissions\": {\n \"ChangeSessionStatus\": true,\n \"PassOrFailAttendees\": true,\n \"ModifyAttendance\": true\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
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.series.hr/sessions/create")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Title\": \"Training Session\",\n \"Scheduled\": \"2023-11-07T05:31:56Z\",\n \"Duration\": 2,\n \"Description\": \"<string>\",\n \"Host\": \"714760171\",\n \"CoHost\": \"<string>\",\n \"Supervisor\": \"<string>\",\n \"Claimable\": true,\n \"CustomRoles\": [\n {\n \"name\": \"<string>\",\n \"slots\": 5,\n \"minRank\": 1,\n \"permissions\": {\n \"ChangeSessionStatus\": true,\n \"PassOrFailAttendees\": true,\n \"ModifyAttendance\": true\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.series.hr/sessions/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Title\": \"Training Session\",\n \"Scheduled\": \"2023-11-07T05:31:56Z\",\n \"Duration\": 2,\n \"Description\": \"<string>\",\n \"Host\": \"714760171\",\n \"CoHost\": \"<string>\",\n \"Supervisor\": \"<string>\",\n \"Claimable\": true,\n \"CustomRoles\": [\n {\n \"name\": \"<string>\",\n \"slots\": 5,\n \"minRank\": 1,\n \"permissions\": {\n \"ChangeSessionStatus\": true,\n \"PassOrFailAttendees\": true,\n \"ModifyAttendance\": true\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_bodySessions
Create Session
Create a new session
POST
/
sessions
/
create
Create Session
curl --request POST \
--url https://api.series.hr/sessions/create \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"Title": "Training Session",
"Scheduled": "2023-11-07T05:31:56Z",
"Duration": 2,
"Description": "<string>",
"Host": "714760171",
"CoHost": "<string>",
"Supervisor": "<string>",
"Claimable": true,
"CustomRoles": [
{
"name": "<string>",
"slots": 5,
"minRank": 1,
"permissions": {
"ChangeSessionStatus": true,
"PassOrFailAttendees": true,
"ModifyAttendance": true
}
}
]
}
'import requests
url = "https://api.series.hr/sessions/create"
payload = {
"Title": "Training Session",
"Scheduled": "2023-11-07T05:31:56Z",
"Duration": 2,
"Description": "<string>",
"Host": "714760171",
"CoHost": "<string>",
"Supervisor": "<string>",
"Claimable": True,
"CustomRoles": [
{
"name": "<string>",
"slots": 5,
"minRank": 1,
"permissions": {
"ChangeSessionStatus": True,
"PassOrFailAttendees": True,
"ModifyAttendance": True
}
}
]
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Title: 'Training Session',
Scheduled: '2023-11-07T05:31:56Z',
Duration: 2,
Description: '<string>',
Host: '714760171',
CoHost: '<string>',
Supervisor: '<string>',
Claimable: true,
CustomRoles: [
{
name: '<string>',
slots: 5,
minRank: 1,
permissions: {ChangeSessionStatus: true, PassOrFailAttendees: true, ModifyAttendance: true}
}
]
})
};
fetch('https://api.series.hr/sessions/create', 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.series.hr/sessions/create",
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([
'Title' => 'Training Session',
'Scheduled' => '2023-11-07T05:31:56Z',
'Duration' => 2,
'Description' => '<string>',
'Host' => '714760171',
'CoHost' => '<string>',
'Supervisor' => '<string>',
'Claimable' => true,
'CustomRoles' => [
[
'name' => '<string>',
'slots' => 5,
'minRank' => 1,
'permissions' => [
'ChangeSessionStatus' => true,
'PassOrFailAttendees' => true,
'ModifyAttendance' => true
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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.series.hr/sessions/create"
payload := strings.NewReader("{\n \"Title\": \"Training Session\",\n \"Scheduled\": \"2023-11-07T05:31:56Z\",\n \"Duration\": 2,\n \"Description\": \"<string>\",\n \"Host\": \"714760171\",\n \"CoHost\": \"<string>\",\n \"Supervisor\": \"<string>\",\n \"Claimable\": true,\n \"CustomRoles\": [\n {\n \"name\": \"<string>\",\n \"slots\": 5,\n \"minRank\": 1,\n \"permissions\": {\n \"ChangeSessionStatus\": true,\n \"PassOrFailAttendees\": true,\n \"ModifyAttendance\": true\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
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.series.hr/sessions/create")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Title\": \"Training Session\",\n \"Scheduled\": \"2023-11-07T05:31:56Z\",\n \"Duration\": 2,\n \"Description\": \"<string>\",\n \"Host\": \"714760171\",\n \"CoHost\": \"<string>\",\n \"Supervisor\": \"<string>\",\n \"Claimable\": true,\n \"CustomRoles\": [\n {\n \"name\": \"<string>\",\n \"slots\": 5,\n \"minRank\": 1,\n \"permissions\": {\n \"ChangeSessionStatus\": true,\n \"PassOrFailAttendees\": true,\n \"ModifyAttendance\": true\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.series.hr/sessions/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Title\": \"Training Session\",\n \"Scheduled\": \"2023-11-07T05:31:56Z\",\n \"Duration\": 2,\n \"Description\": \"<string>\",\n \"Host\": \"714760171\",\n \"CoHost\": \"<string>\",\n \"Supervisor\": \"<string>\",\n \"Claimable\": true,\n \"CustomRoles\": [\n {\n \"name\": \"<string>\",\n \"slots\": 5,\n \"minRank\": 1,\n \"permissions\": {\n \"ChangeSessionStatus\": true,\n \"PassOrFailAttendees\": true,\n \"ModifyAttendance\": true\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyCreate a new session with optional scheduling and duration parameters.
Request
curl -X POST https://api.series.hr/sessions/create \
-H "apikey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"Title": "Training Session",
"Host": "714760171",
"Scheduled": "2024-01-20T15:00:00Z",
"Duration": 60,
"CustomRoles": [
{
"name": "Trainer",
"slots": 2,
"minRank": 50,
"permissions": {
"ChangeSessionStatus": false,
"PassOrFailAttendees": true,
"ModifyAttendance": true
}
}
]
}'
Parameters
string
required
Session title
string
required
ISO 8601 scheduled start time
integer
required
Session duration in minutes (must be a positive integer)
string
Roblox user ID of the host (optional, must be a workspace member)
string
Detailed session description (optional)
string
Roblox user ID of the co-host (optional)
string
Roblox user ID of the supervisor (optional)
boolean
Whether users can claim attendance (default: false)
array
Array of custom role definitions (Premium/Enterprise only). Each role object has:
name(string, required): Role name (must be unique, cannot be “Host”, “CoHost”, or “Supervisor”)slots(integer, required): Number of slots (1-10)minRank(integer, optional): Minimum rank requirement (default: 0)permissions(object, optional): Role permissionsChangeSessionStatus(boolean): Can start/delay/cancel/end the sessionPassOrFailAttendees(boolean): Can mark attendees as passed/failedModifyAttendance(boolean): Can manage the attendance list
Response
{
"success": true,
"data": {
"sessionId": "session_abc123",
"Title": "Training Session",
"Host": "714760171",
"Scheduled": "2024-01-20T15:00:00Z",
"Duration": 3600,
"createdAt": "2024-01-15T10:30:00Z"
}
}
Authorizations
Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.
Body
application/json
Session title
Example:
"Training Session"
Session start time in ISO 8601 format
Duration in minutes (positive integer)
Required range:
x >= 1Detailed session description
Roblox user ID of the host (optional, must be a workspace member)
Example:
"714760171"
Roblox user ID of co-host (optional)
Roblox user ID of supervisor (optional)
Whether users can claim attendance (default: false)
Custom role definitions (Premium/Enterprise only)
Show child attributes
Show child attributes
Response
Session created
⌘I

