Set the rooms

PUT/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Replaces the room list, in order. Keep a room by sending its id (a new name renames it); add one with a name only. A room left out is removed, unless a session still uses it: then nothing changes (409, code: in_use). Requires write:sessions. Refused for a key restricted to particular events. Also at PUT /v1/sessions-workspace/events/{eventId}/rooms.

Request example

cURL

curl --request PUT \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rooms": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "capacity": 0
    }
  ],
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms', {
  method: 'PUT',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "rooms": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "capacity": 0
      }
    ],
    "source": {
      "client": "<string>",
      "version": "<string>",
      "run_id": "<string>",
      "prompt": "<string>"
    }
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "PUT",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "rooms": [
            {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>",
                "capacity": 0
            }
        ],
        "source": {
            "client": "<string>",
            "version": "<string>",
            "run_id": "<string>",
            "prompt": "<string>"
        }
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_POSTFIELDS => '{
  "rooms": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "capacity": 0
    }
  ],
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  req, _ := http.NewRequest("PUT", "https://public-api.sessionboard.com/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms", strings.NewReader(`{
  "rooms": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "capacity": 0
    }
  ],
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}`))
  req.Header.Add("x-access-token", "<api-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))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/sessions-workspace/events/{eventId}/rooms"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\n  \"rooms\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\",\n      \"capacity\": 0\n    }\n  ],\n  \"source\": {\n    \"client\": \"<string>\",\n    \"version\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"prompt\": \"<string>\"\n  }\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

eventId*

Body application/json

{ "rooms": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "capacity": 0 } ], "source": { "client": "<string>", "version": "<string>", "run_id": "<string>", "prompt": "<string>" } }

PUT

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

• eventIdintegerpathrequired

  The Sessions event ID.

Request body

application/jsonrequired

• roomsobject[]required

  Max items

  50

  Show child attributes

  • idstring<uuid>
  • namestringrequired

    Max length

    255

  • capacityinteger

    Minimum

    0

• sourceSessionsWorkspaceSource

  Optional on every write: which assistant is calling and what the person asked it. Recorded with the change in the organization's activity and on any approval request.

  Show child attributes

  • clientstring
  • versionstring
  • run_idstring
  • promptstring

    Max length

    2000

Example

{
  "rooms": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "capacity": 0
    }
  ],
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}

Responses

200application/json

OK

• successboolean
• payloadobject
  Show child attributes

  • roomsSessionsWorkspaceRoom[]
    Show child attributes

    • idstring<uuid>
    • namestring
    • capacityinteger | null

400application/json

VALIDATION_ERROR: the body or a path id does not match the schema. source is always accepted.

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason: enterprise_only, trial_ended, plan_ended, in_use.

• upgradestring

  With enterprise_only: what needs a bigger plan or the platform (events, speakers, review_plans, forms, …).

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED: the token lacks write:sessions.
• ORG_WIDE_TOKEN_REQUIRED: the key is restricted to particular events.
• code: enterprise_only with upgrade: the self-serve plan does not include it (another event this year, more speakers on the event); a person chooses a bigger plan or talks to us about the platform.
• code: trial_ended or plan_ended: the self-serve plan is read-only; everything can still be read.
• FORBIDDEN with no code: the token's user is not an organization admin.

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason: enterprise_only, trial_ended, plan_ended, in_use.

• upgradestring

  With enterprise_only: what needs a bigger plan or the platform (events, speakers, review_plans, forms, …).

404application/json

NOT_FOUND: orgId is not the token's organization, or the event, session or sponsor is not in it.

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason: enterprise_only, trial_ended, plan_ended, in_use.

• upgradestring

  With enterprise_only: what needs a bigger plan or the platform (events, speakers, review_plans, forms, …).

409application/json

code: in_use: a room or track left out still has sessions. Nothing changed; move them first.

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason: enterprise_only, trial_ended, plan_ended, in_use.

• upgradestring

  With enterprise_only: what needs a bigger plan or the platform (events, speakers, review_plans, forms, …).

423

A person has paused connected assistants for the organization (code: AGENT_WRITES_PAUSED); writes wait until they resume it in Sessionboard.

429

The token's request limit (100 requests per 15 minutes by default) or, for writes, its daily write quota. Wait Retry-After seconds.

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

200

{
  "success": true,
  "payload": {
    "rooms": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "capacity": 123
      }
    ]
  }
}

400

{
  "error": "VALIDATION_ERROR",
  "message": "<string>",
  "code": "<string>",
  "upgrade": "<string>"
}

403 · Past the plan's speakers per event

{
  "message": "This event has reached the speakers your plan includes. Bigger events are part of Growth or the Sessionboard platform.",
  "code": "enterprise_only",
  "upgrade": "speakers"
}

403 · The trial has ended

{
  "message": "Your Sessions trial has ended. Choose a plan to keep going.",
  "code": "trial_ended"
}

404

{
  "error": "VALIDATION_ERROR",
  "message": "<string>",
  "code": "<string>",
  "upgrade": "<string>"
}

409

{
  "error": "VALIDATION_ERROR",
  "message": "<string>",
  "code": "<string>",
  "upgrade": "<string>"
}