Rooms

Endpoints

Method	Path	Description
`POST`	`/api/v2/rooms`	Create a room
`GET`	`/api/v2/rooms/{room_id}`	Get a room
`GET`	`/api/v2/rooms`	List rooms
`PATCH`	`/api/v2/rooms/{room_id}`	Update a room

Create a room

POST /api/v2/rooms

Body parameters

title

string

The display title of the room.

description

string

Optional description.

templateId

string

Template ID to initialise the room from. Ignored when duplicateFromId is set.

duplicateFromId

string

ID of an existing room to duplicate.

companyId

string

ID of the company to associate with this room.

statusId

string

ID of the status to set on the room.

labelId

string

ID of the label to apply.

userId

string

ID of the Flowla user to assign as room owner.

string

Email address of the primary contact.

hsDealId

string

HubSpot deal ID to link this room to.

sfOpportunityId

string

Salesforce opportunity ID (e.g. 0064x000009abcD).

attioDealId

string

Attio deal ID (e.g. deal-abc-123).

coverTitle

string

Title displayed on the room’s cover page.

coverDescription

string

Description displayed on the room’s cover page.

coverDisabled

boolean

When true, the cover page is hidden.

themeColor

string

Background color as a hex value (e.g. #FF5500).

navColor

string

Navigation bar color. Accepts a hex value, "flow-org-color" (your org’s brand color), or "target-company-color" (the associated company’s color).

Modes

Blank room
From template
Duplicate room
With CRM link

{
  "title": "Acme Corp – Onboarding",
  "email": "buyer@acme.com",
  "companyId": "<company_id>"
}

{
  "title": "Acme Corp – Onboarding",
  "templateId": "<template_id>",
  "email": "buyer@acme.com"
}

{
  "title": "Acme Corp – Onboarding (copy)",
  "duplicateFromId": "<room_id>"
}

{
  "title": "Globex Q3 Deal",
  "templateId": "<template_id>",
  "hsDealId": "12345678",
  "userId": "<user_id>"
}

curl -X POST https://api.flowla.com/api/v2/rooms \
  -H "x-flowla-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Acme Corp – Onboarding",
    "templateId": "<template_id>",
    "email": "buyer@acme.com",
    "hsDealId": "12345678"
  }'

import requests

response = requests.post(
    "https://api.flowla.com/api/v2/rooms",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    json={
        "title": "Acme Corp – Onboarding",
        "templateId": "<template_id>",
        "email": "buyer@acme.com",
        "hsDealId": "12345678",
    },
)
print(response.json())

const res = await fetch("https://api.flowla.com/api/v2/rooms", {
  method: "POST",
  headers: {
    "x-flowla-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "Acme Corp – Onboarding",
    templateId: "<template_id>",
    email: "buyer@acme.com",
    hsDealId: "12345678",
  }),
});
const room = await res.json();

Get a room

GET /api/v2/rooms/{room_id}

curl https://api.flowla.com/api/v2/rooms/<room_id> \
  -H "x-flowla-api-key: YOUR_API_KEY"

response = requests.get(
    "https://api.flowla.com/api/v2/rooms/<room_id>",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
)

const res = await fetch("https://api.flowla.com/api/v2/rooms/<room_id>", {
  headers: { "x-flowla-api-key": "YOUR_API_KEY" },
});

List rooms

GET /api/v2/rooms

Query parameters

page

number

Page number (default: 1).

limit

number

Results per page (default: 10).

sortBy

"createdAt" | "updatedAt" | "totalEngagements" | "lastEngagedAt"

Field to sort by (default: createdAt).

sortDirection

"ASC" | "DESC"

Sort direction (default: DESC).

Response fields

Each room in results includes:

Field	Type	Description
`id`	string	Room identifier
`title`	string	Room title
`userId`	string \| null	Room owner user ID
`companyId`	string \| null	Associated company ID
`createdAt`	string	ISO 8601
`updatedAt`	string	ISO 8601
`totalEngagements`	number \| null	Total engagement actions across all types
`lastEngagedAt`	string \| null	Timestamp of the last engagement
`totalViews`	number \| null	Total page view count
`totalUniqueViews`	number \| null	Unique viewer count
`engagements`	object \| null	Breakdown: `clicks`, `comments`, `downloads`, `reactions`, `shares`, `views`, `tasksCompleted`
`coverTitle`	string \| null	Cover page title
`coverDescription`	string \| null	Cover page description
`coverDisabled`	boolean \| null	Whether the cover page is hidden
`themeColor`	string \| null	Background color
`navColor`	string \| null	Navigation bar color

curl "https://api.flowla.com/api/v2/rooms?page=1&limit=20" \
  -H "x-flowla-api-key: YOUR_API_KEY"

response = requests.get(
    "https://api.flowla.com/api/v2/rooms",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    params={"page": 1, "limit": 20},
)

const res = await fetch("https://api.flowla.com/api/v2/rooms?page=1&limit=20", {
  headers: { "x-flowla-api-key": "YOUR_API_KEY" },
});

Update a room

PATCH /api/v2/rooms/{room_id} All fields are optional. Only provided fields are updated.

title

string

New display title.

description

string

New description.

statusId

string

New status ID.

userId

string

Sets the room owner.

companyId

string

Links the room to a company.

hsDealId

string

HubSpot deal ID.

sfOpportunityId

string

Salesforce opportunity ID.

attioDealId

string

Attio deal ID.

coverTitle

string

Cover page title.

coverDescription

string

Cover page description.

coverDisabled

boolean

When true, the cover page is hidden.

themeColor

string

Background color as a hex value (e.g. #FF5500).

navColor

string

Navigation bar color. Accepts a hex value, "flow-org-color", or "target-company-color".

Example

{
  "title": "Globex – Closed Won",
  "statusId": "<status_id>",
  "userId": "<user_id>"
}

curl -X PATCH https://api.flowla.com/api/v2/rooms/<room_id> \
  -H "x-flowla-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Globex – Closed Won", "statusId": "<status_id>"}'

requests.patch(
    "https://api.flowla.com/api/v2/rooms/<room_id>",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    json={"title": "Globex – Closed Won", "statusId": "<status_id>"},
)

await fetch("https://api.flowla.com/api/v2/rooms/<room_id>", {
  method: "PATCH",
  headers: {
    "x-flowla-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ title: "Globex – Closed Won", statusId: "<status_id>" }),
});

Getting started

Structure

Action Items

Automation

Lookups

Rooms

Endpoints

Create a room

Body parameters

Modes

Get a room

List rooms

Query parameters

Response fields

Update a room

​Endpoints

​Create a room

​Body parameters

​Modes

​Get a room

​List rooms

​Query parameters

​Response fields

​Update a room

Endpoints

Create a room

Body parameters

Modes

Get a room

List rooms

Query parameters

Response fields

Update a room