Skip to main content
POST
Create a room

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

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.