Skip to main content
POST
/
rooms
/
Create a room
curl --request POST \
  --url https://api.journeybee.io/v1/rooms/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "room_type": "custom",
  "live": false,
  "room_visibility": "all",
  "series": 123,
  "internal_label": "<string>",
  "viewable_by_distributors": true,
  "room_settings": {
    "show_navigation": true,
    "overview": {
      "showQuickActions": true
    }
  }
}
'
{
  "uuid": "<string>",
  "label": "<string>",
  "live": true,
  "series": 123,
  "internal_label": "<string>",
  "viewable_by_distributors": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "tiers": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "categories": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "stages": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "tags": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "blocks": [
    {
      "uuid": "<string>",
      "label": "<string>",
      "series": 123,
      "content": "<unknown>",
      "block_settings": {
        "display": {
          "height": 123,
          "fullScreen": true,
          "showExternalLink": true
        },
        "action_bar": {
          "buttons": [
            {
              "label": "<string>",
              "icon": "<string>",
              "url": "<string>",
              "background_color": "<string>",
              "text_color": "<string>",
              "icon_color": "<string>",
              "room_uuid": "<string>",
              "series": 500
            }
          ]
        },
        "goals": {
          "showProgress": true,
          "showCountdown": true,
          "allowResourceLinks": true
        },
        "advanced_search": {
          "title": "<string>",
          "placeholder": "<string>",
          "showAITab": true,
          "showQuickActions": true
        },
        "pricing_calculator": {
          "allowCreateLead": true,
          "enable_lead_submission": true,
          "customCustomerName": "<string>"
        },
        "banner": {}
      },
      "asset_uuid": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "room_settings": {
    "show_navigation": true,
    "overview": {
      "showQuickActions": true
    },
    "style": {
      "sidebar_icon": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json

Create a room. After creation, add content blocks (text, image, video, etc.) via the blocks sub-resource, and configure access via tiers/categories/stages sub-resources.

Create a room. After creation, add content blocks (text, image, video, etc.) via the blocks sub-resource, and configure access via tiers/categories/stages sub-resources.

label
string
required

Room title displayed in partner portal sidebar

Required string length: 1 - 500
room_type
enum<string>
default:custom
required

Room type: overview, distributor_partners, leads, deals, payments, resources, certifications, projects, contacts, messages, brand_guidelines, shared_files, private_files, mdf, campaigns, or custom

Available options:
overview,
distributor_partners,
leads,
deals,
payments,
resources,
certifications,
projects,
contacts,
messages,
brand_guidelines,
shared_files,
private_files,
mdf,
campaigns,
custom
live
boolean
default:false
required

Whether room is published and visible to partners

partner_type
enum<string>
required

Which partner type this room is for: referral, reseller, or distributor

Available options:
referral,
reseller,
distributor
room_visibility
enum<string>
default:all
required

all: visible to everyone. internal_only: company employees only. external_only: external partners only.

Available options:
all,
internal_only,
external_only
series
number

Display order in sidebar (1-indexed)

internal_label
string | null

Internal-only label (not shown to partners)

viewable_by_distributors
boolean

Whether distributor partners can see this room

room_settings
object

Room-level configuration

Response

201 - application/json

Default Response

uuid
string
required
label
string | null
required
room_type
enum<string>
required
Available options:
overview,
distributor_partners,
leads,
deals,
payments,
resources,
certifications,
projects,
contacts,
messages,
brand_guidelines,
shared_files,
private_files,
mdf,
campaigns,
custom
live
boolean
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
series
number
required
room_visibility
enum<string>
required
Available options:
all,
internal_only,
external_only
internal_label
string | null
required
viewable_by_distributors
boolean
required
created_at
string
required
updated_at
string
required
tiers
object[]
required
categories
object[]
required
stages
object[]
required
tags
object[]
required
blocks
object[]
required
room_settings
object
required

Room-level configuration.