Skip to main content

​
Endpoints

MethodPathDescription
POST/api/v2/roomsCreate a room
GET/api/v2/rooms/{room_id}Get a room
GET/api/v2/roomsList 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.
​
email
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

{
  "title": "Acme Corp – Onboarding",
  "email": "buyer@acme.com",
  "companyId": "<company_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"
  }'

​
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"

​
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:
FieldTypeDescription
idstringRoom identifier
titlestringRoom title
userIdstring | nullRoom owner user ID
companyIdstring | nullAssociated company ID
createdAtstringISO 8601
updatedAtstringISO 8601
totalEngagementsnumber | nullTotal engagement actions across all types
lastEngagedAtstring | nullTimestamp of the last engagement
totalViewsnumber | nullTotal page view count
totalUniqueViewsnumber | nullUnique viewer count
engagementsobject | nullBreakdown: clicks, comments, downloads, reactions, shares, views, tasksCompleted
coverTitlestring | nullCover page title
coverDescriptionstring | nullCover page description
coverDisabledboolean | nullWhether the cover page is hidden
themeColorstring | nullBackground color
navColorstring | nullNavigation bar color
curl "https://api.flowla.com/api/v2/rooms?page=1&limit=20" \
  -H "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>"}'