Update Tournament Route
curl --request PATCH \
--url https://softmax.com/api/observatory/v2/tournaments/{tournament_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"name": "<string>",
"roster_generator": {
"entrants": [
{
"player_id": "<string>",
"policy_version_id": "<string>",
"display_name": "<string>"
}
],
"host_division_id": "<string>",
"type": "explicit"
},
"schedule": {
"mode": "on_demand",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
},
"round_generator": {
"strategy": "double_elimination",
"grand_final_reset": true,
"best_of": 1
},
"placements": {
"type": "bracket_finish",
"tiers": [
{
"name": "<string>",
"ranks": [
123,
123
]
}
]
}
}
}
'import requests
url = "https://softmax.com/api/observatory/v2/tournaments/{tournament_id}"
payload = { "definition": {
"name": "<string>",
"roster_generator": {
"entrants": [
{
"player_id": "<string>",
"policy_version_id": "<string>",
"display_name": "<string>"
}
],
"host_division_id": "<string>",
"type": "explicit"
},
"schedule": {
"mode": "on_demand",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
},
"round_generator": {
"strategy": "double_elimination",
"grand_final_reset": True,
"best_of": 1
},
"placements": {
"type": "bracket_finish",
"tiers": [
{
"name": "<string>",
"ranks": [123, 123]
}
]
}
} }
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({
definition: {
name: '<string>',
roster_generator: {
entrants: [
{player_id: '<string>', policy_version_id: '<string>', display_name: '<string>'}
],
host_division_id: '<string>',
type: 'explicit'
},
schedule: {
mode: 'on_demand',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z'
},
round_generator: {strategy: 'double_elimination', grand_final_reset: true, best_of: 1},
placements: {type: 'bracket_finish', tiers: [{name: '<string>', ranks: [123, 123]}]}
}
})
};
fetch('https://softmax.com/api/observatory/v2/tournaments/{tournament_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://softmax.com/api/observatory/v2/tournaments/{tournament_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([
'definition' => [
'name' => '<string>',
'roster_generator' => [
'entrants' => [
[
'player_id' => '<string>',
'policy_version_id' => '<string>',
'display_name' => '<string>'
]
],
'host_division_id' => '<string>',
'type' => 'explicit'
],
'schedule' => [
'mode' => 'on_demand',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z'
],
'round_generator' => [
'strategy' => 'double_elimination',
'grand_final_reset' => true,
'best_of' => 1
],
'placements' => [
'type' => 'bracket_finish',
'tiers' => [
[
'name' => '<string>',
'ranks' => [
123,
123
]
]
]
]
]
]),
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://softmax.com/api/observatory/v2/tournaments/{tournament_id}"
payload := strings.NewReader("{\n \"definition\": {\n \"name\": \"<string>\",\n \"roster_generator\": {\n \"entrants\": [\n {\n \"player_id\": \"<string>\",\n \"policy_version_id\": \"<string>\",\n \"display_name\": \"<string>\"\n }\n ],\n \"host_division_id\": \"<string>\",\n \"type\": \"explicit\"\n },\n \"schedule\": {\n \"mode\": \"on_demand\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\"\n },\n \"round_generator\": {\n \"strategy\": \"double_elimination\",\n \"grand_final_reset\": true,\n \"best_of\": 1\n },\n \"placements\": {\n \"type\": \"bracket_finish\",\n \"tiers\": [\n {\n \"name\": \"<string>\",\n \"ranks\": [\n 123,\n 123\n ]\n }\n ]\n }\n }\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://softmax.com/api/observatory/v2/tournaments/{tournament_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"name\": \"<string>\",\n \"roster_generator\": {\n \"entrants\": [\n {\n \"player_id\": \"<string>\",\n \"policy_version_id\": \"<string>\",\n \"display_name\": \"<string>\"\n }\n ],\n \"host_division_id\": \"<string>\",\n \"type\": \"explicit\"\n },\n \"schedule\": {\n \"mode\": \"on_demand\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\"\n },\n \"round_generator\": {\n \"strategy\": \"double_elimination\",\n \"grand_final_reset\": true,\n \"best_of\": 1\n },\n \"placements\": {\n \"type\": \"bracket_finish\",\n \"tiers\": [\n {\n \"name\": \"<string>\",\n \"ranks\": [\n 123,\n 123\n ]\n }\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://softmax.com/api/observatory/v2/tournaments/{tournament_id}")
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 \"definition\": {\n \"name\": \"<string>\",\n \"roster_generator\": {\n \"entrants\": [\n {\n \"player_id\": \"<string>\",\n \"policy_version_id\": \"<string>\",\n \"display_name\": \"<string>\"\n }\n ],\n \"host_division_id\": \"<string>\",\n \"type\": \"explicit\"\n },\n \"schedule\": {\n \"mode\": \"on_demand\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\"\n },\n \"round_generator\": {\n \"strategy\": \"double_elimination\",\n \"grand_final_reset\": true,\n \"best_of\": 1\n },\n \"placements\": {\n \"type\": \"bracket_finish\",\n \"tiers\": [\n {\n \"name\": \"<string>\",\n \"ranks\": [\n 123,\n 123\n ]\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"tournament_id": "<string>",
"league_id": "<string>",
"name": "<string>",
"status": "draft",
"definition": {
"name": "<string>",
"schedule": {
"mode": "on_demand",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
},
"roster_generator": {
"type": "explicit",
"entrants": [
{
"player_id": "<string>",
"policy_version_id": "<string>",
"display_name": "<string>"
}
],
"host_division_id": "<string>"
},
"round_generator": {
"strategy": "double_elimination",
"grand_final_reset": true,
"best_of": 1
},
"placements": {
"type": "bracket_finish",
"tiers": [
{
"name": "<string>",
"ranks": [
123,
123
]
}
]
}
},
"frozen_entrants": [
{
"entrant_id": "<string>",
"player_id": "<string>",
"policy_version_id": "<string>",
"seed": 123,
"display_name": "<string>",
"league_policy_membership_id": "<string>"
}
],
"visualization": {
"strategy": "double_elimination",
"size": 123,
"grand_final_reset": true,
"entrants": [
{
"entrant_id": "<string>",
"player_id": "<string>",
"policy_version_id": "<string>",
"seed": 123,
"display_name": "<string>"
}
],
"matches": [
{
"match_id": "<string>",
"bracket": "winners",
"round_index": 123,
"slot_index": 123,
"label": "<string>",
"series_format": "bo1",
"entrant_a_id": "<string>",
"entrant_b_id": "<string>",
"winner_entrant_id": "<string>",
"status": "pending",
"edges": [
{
"to_match_id": "<string>",
"slot": "a",
"kind": "advance"
}
]
}
],
"current_round_key": "<string>",
"highlight_match_ids": [
"<string>"
],
"champion_entrant_id": "<string>"
},
"placements": [
{
"entrant_id": "<string>",
"player_id": "<string>",
"rank": 123,
"tier": "<string>",
"score": 123
}
],
"locked_at": "2023-11-07T05:31:56Z",
"locked_by": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"requester_user_id": "<string>",
"host_division_id": "<string>",
"wave_experience_request_ids": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}v2
Update Tournament Route
Replace a draft tournament’s definition (name, roster, bracket options).
Drafts only — the definition freezes at :lock. for_update serializes
an edit against a racing lock so the roster the lock resolves is the one
the editor last saved.
PATCH
/
v2
/
tournaments
/
{tournament_id}
Update Tournament Route
curl --request PATCH \
--url https://softmax.com/api/observatory/v2/tournaments/{tournament_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"name": "<string>",
"roster_generator": {
"entrants": [
{
"player_id": "<string>",
"policy_version_id": "<string>",
"display_name": "<string>"
}
],
"host_division_id": "<string>",
"type": "explicit"
},
"schedule": {
"mode": "on_demand",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
},
"round_generator": {
"strategy": "double_elimination",
"grand_final_reset": true,
"best_of": 1
},
"placements": {
"type": "bracket_finish",
"tiers": [
{
"name": "<string>",
"ranks": [
123,
123
]
}
]
}
}
}
'import requests
url = "https://softmax.com/api/observatory/v2/tournaments/{tournament_id}"
payload = { "definition": {
"name": "<string>",
"roster_generator": {
"entrants": [
{
"player_id": "<string>",
"policy_version_id": "<string>",
"display_name": "<string>"
}
],
"host_division_id": "<string>",
"type": "explicit"
},
"schedule": {
"mode": "on_demand",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
},
"round_generator": {
"strategy": "double_elimination",
"grand_final_reset": True,
"best_of": 1
},
"placements": {
"type": "bracket_finish",
"tiers": [
{
"name": "<string>",
"ranks": [123, 123]
}
]
}
} }
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({
definition: {
name: '<string>',
roster_generator: {
entrants: [
{player_id: '<string>', policy_version_id: '<string>', display_name: '<string>'}
],
host_division_id: '<string>',
type: 'explicit'
},
schedule: {
mode: 'on_demand',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z'
},
round_generator: {strategy: 'double_elimination', grand_final_reset: true, best_of: 1},
placements: {type: 'bracket_finish', tiers: [{name: '<string>', ranks: [123, 123]}]}
}
})
};
fetch('https://softmax.com/api/observatory/v2/tournaments/{tournament_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://softmax.com/api/observatory/v2/tournaments/{tournament_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([
'definition' => [
'name' => '<string>',
'roster_generator' => [
'entrants' => [
[
'player_id' => '<string>',
'policy_version_id' => '<string>',
'display_name' => '<string>'
]
],
'host_division_id' => '<string>',
'type' => 'explicit'
],
'schedule' => [
'mode' => 'on_demand',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z'
],
'round_generator' => [
'strategy' => 'double_elimination',
'grand_final_reset' => true,
'best_of' => 1
],
'placements' => [
'type' => 'bracket_finish',
'tiers' => [
[
'name' => '<string>',
'ranks' => [
123,
123
]
]
]
]
]
]),
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://softmax.com/api/observatory/v2/tournaments/{tournament_id}"
payload := strings.NewReader("{\n \"definition\": {\n \"name\": \"<string>\",\n \"roster_generator\": {\n \"entrants\": [\n {\n \"player_id\": \"<string>\",\n \"policy_version_id\": \"<string>\",\n \"display_name\": \"<string>\"\n }\n ],\n \"host_division_id\": \"<string>\",\n \"type\": \"explicit\"\n },\n \"schedule\": {\n \"mode\": \"on_demand\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\"\n },\n \"round_generator\": {\n \"strategy\": \"double_elimination\",\n \"grand_final_reset\": true,\n \"best_of\": 1\n },\n \"placements\": {\n \"type\": \"bracket_finish\",\n \"tiers\": [\n {\n \"name\": \"<string>\",\n \"ranks\": [\n 123,\n 123\n ]\n }\n ]\n }\n }\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://softmax.com/api/observatory/v2/tournaments/{tournament_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"name\": \"<string>\",\n \"roster_generator\": {\n \"entrants\": [\n {\n \"player_id\": \"<string>\",\n \"policy_version_id\": \"<string>\",\n \"display_name\": \"<string>\"\n }\n ],\n \"host_division_id\": \"<string>\",\n \"type\": \"explicit\"\n },\n \"schedule\": {\n \"mode\": \"on_demand\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\"\n },\n \"round_generator\": {\n \"strategy\": \"double_elimination\",\n \"grand_final_reset\": true,\n \"best_of\": 1\n },\n \"placements\": {\n \"type\": \"bracket_finish\",\n \"tiers\": [\n {\n \"name\": \"<string>\",\n \"ranks\": [\n 123,\n 123\n ]\n }\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://softmax.com/api/observatory/v2/tournaments/{tournament_id}")
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 \"definition\": {\n \"name\": \"<string>\",\n \"roster_generator\": {\n \"entrants\": [\n {\n \"player_id\": \"<string>\",\n \"policy_version_id\": \"<string>\",\n \"display_name\": \"<string>\"\n }\n ],\n \"host_division_id\": \"<string>\",\n \"type\": \"explicit\"\n },\n \"schedule\": {\n \"mode\": \"on_demand\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\"\n },\n \"round_generator\": {\n \"strategy\": \"double_elimination\",\n \"grand_final_reset\": true,\n \"best_of\": 1\n },\n \"placements\": {\n \"type\": \"bracket_finish\",\n \"tiers\": [\n {\n \"name\": \"<string>\",\n \"ranks\": [\n 123,\n 123\n ]\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"tournament_id": "<string>",
"league_id": "<string>",
"name": "<string>",
"status": "draft",
"definition": {
"name": "<string>",
"schedule": {
"mode": "on_demand",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
},
"roster_generator": {
"type": "explicit",
"entrants": [
{
"player_id": "<string>",
"policy_version_id": "<string>",
"display_name": "<string>"
}
],
"host_division_id": "<string>"
},
"round_generator": {
"strategy": "double_elimination",
"grand_final_reset": true,
"best_of": 1
},
"placements": {
"type": "bracket_finish",
"tiers": [
{
"name": "<string>",
"ranks": [
123,
123
]
}
]
}
},
"frozen_entrants": [
{
"entrant_id": "<string>",
"player_id": "<string>",
"policy_version_id": "<string>",
"seed": 123,
"display_name": "<string>",
"league_policy_membership_id": "<string>"
}
],
"visualization": {
"strategy": "double_elimination",
"size": 123,
"grand_final_reset": true,
"entrants": [
{
"entrant_id": "<string>",
"player_id": "<string>",
"policy_version_id": "<string>",
"seed": 123,
"display_name": "<string>"
}
],
"matches": [
{
"match_id": "<string>",
"bracket": "winners",
"round_index": 123,
"slot_index": 123,
"label": "<string>",
"series_format": "bo1",
"entrant_a_id": "<string>",
"entrant_b_id": "<string>",
"winner_entrant_id": "<string>",
"status": "pending",
"edges": [
{
"to_match_id": "<string>",
"slot": "a",
"kind": "advance"
}
]
}
],
"current_round_key": "<string>",
"highlight_match_ids": [
"<string>"
],
"champion_entrant_id": "<string>"
},
"placements": [
{
"entrant_id": "<string>",
"player_id": "<string>",
"rank": 123,
"tier": "<string>",
"score": 123
}
],
"locked_at": "2023-11-07T05:31:56Z",
"locked_by": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"requester_user_id": "<string>",
"host_division_id": "<string>",
"wave_experience_request_ids": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer token issued by Softmax
Path Parameters
Pattern:
^tour_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Body
application/json
Canonical tournament config stored on the tournament row.
Show child attributes
Show child attributes
Response
Successful Response
Full tournament document served by the detail/lifecycle endpoints.
Available options:
draft, locked, running, completed, cancelled, failed Canonical tournament config stored on the tournament row.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes