Skip to main content
All tool names use snake_case. Optional fields can be omitted entirely.

​
Rooms

Returns a paginated list of rooms with engagement metrics.
FieldTypeRequiredDescription
pagenumberPage number (default: 1)
limitnumberResults per page (default: 10)
sortBystringcreatedAt · updatedAt · totalEngagements · lastEngagedAt
sortDirectionstringASC or DESC (default: DESC)
Response includes: id, title, userId, companyId, totalEngagements, lastEngagedAt, totalViews, totalUniqueViews, engagements breakdown, and design fields.
Creates a new room. Resolve the company and owner first — call list_companies and list_users before this tool.
FieldTypeRequiredDescription
titlestringRoom display title
descriptionstringOptional description
templateIdstringCreate from a template
duplicateFromIdstringDuplicate an existing room
companyIdstringAssociated company ID
userIdstringRoom owner user ID
statusIdstringInitial status
labelIdstringLabel to apply
emailstringPrimary contact email
hsDealIdstringHubSpot deal ID
sfOpportunityIdstringSalesforce opportunity ID
attioDealIdstringAttio deal ID
coverTitlestringCover page title
coverDescriptionstringCover page description
coverDisabledbooleanHide the cover page
themeColorstringBackground color (hex, e.g. #FF5500)
navColorstringNav bar color (hex, "flow-org-color", or "target-company-color")
Returns engagement data for a room: progress, assignees, and section/step viewership.
FieldTypeRequiredDescription
idstring✓Room ID
Updates room properties. All fields optional.
FieldTypeRequiredDescription
idstring✓Room to update
titlestringNew title
descriptionstringNew description
statusIdstringNew status
userIdstringNew owner
companyIdstringNew associated company
hsDealIdstringHubSpot deal ID
sfOpportunityIdstringSalesforce opportunity ID
attioDealIdstringAttio deal ID
coverTitlestringCover page title
coverDescriptionstringCover page description
coverDisabledbooleanHide the cover page
themeColorstringBackground color (hex)
navColorstringNav bar color

​
Sections

FieldTypeRequiredDescription
roomIdstring✓Room to list sections from
FieldTypeRequiredDescription
roomIdstring✓Room to add sections to
sectionsarray✓Array of { title, access? } objects
access options: visible (default) · restricted · locked · hidden
FieldTypeRequiredDescription
idstring✓Section to update
titlestringNew title
accessstringNew access level
Permanently deletes the section and all its pages, groups, and blocks.
FieldTypeRequiredDescription
idstring✓Section to delete

​
Pages

FieldTypeRequiredDescription
sectionIdstring✓Section to list pages from
FieldTypeRequiredDescription
sectionIdstring✓Section to add pages to
pagesarray✓Array of { title, access? } objects
FieldTypeRequiredDescription
idstring✓Page to update
titlestringNew title
accessstringNew access level
FieldTypeRequiredDescription
idstring✓Page to delete

​
Groups

FieldTypeRequiredDescription
pageIdstring✓Page to list groups from
FieldTypeRequiredDescription
pageIdstring✓Page to add groups to
groupsarray✓Array of { title? } objects
FieldTypeRequiredDescription
idstring✓Group to update
pageIdstring✓Page the group belongs to
titlestringNew title
Deletes the group and all its blocks.
FieldTypeRequiredDescription
idstring✓Group to delete
pageIdstring✓Page the group belongs to

​
Blocks

FieldTypeRequiredDescription
pageIdstring✓Page containing the group
groupIdstringFilter by group
Adds blocks to a group. Each element of columns is a vertical stack; multiple elements appear side by side.
FieldTypeRequiredDescription
pageIdstring✓Page the group belongs to
groupIdstringGroup to add blocks to
columnsarray✓Array of { blocks: [{ type, content?, url? }] }
Block types: text · image · embed · link · pdf · action-plan
  • text: content field accepts Markdown (headings, bold, lists, tables, etc.)
  • image / pdf: provide any public url — the file is fetched and stored automatically
  • embed / link: provide url
  • action-plan: no extra fields needed; use create_action_items to add tasks
Single column
{
  "pageId": "<page_id>",
  "columns": [{ "blocks": [{ "type": "text", "content": "## Hello\n\nWelcome!" }] }]
}
Two side-by-side columns
{
  "pageId": "<page_id>",
  "columns": [
    { "blocks": [{ "type": "text", "content": "Left" }] },
    { "blocks": [{ "type": "image", "url": "https://example.com/img.png" }] }
  ]
}
FieldTypeRequiredDescription
idstring✓Block to update
pageIdstring✓Page the block belongs to
contentstringNew text (for text blocks; accepts Markdown)
urlstringNew URL (for image, embed, link, pdf blocks)
FieldTypeRequiredDescription
idstring✓Block to delete
pageIdstring✓Page the block belongs to

​
Action items

FieldTypeRequiredDescription
pageIdstring✓Page containing the block
blockIdstring✓Action-plan block ID
FieldTypeRequiredDescription
pageIdstring✓Page containing the block
blockIdstring✓Action-plan block to add items to
itemsarray✓Array of action item objects
Item fields: title (required), description, status, dueDate, startDate, internal, assignees (email array)
All fields optional. assignees replaces the full list.
FieldTypeRequiredDescription
idstring✓Action item to update
titlestring
descriptionstring
statusstringtodo · in_progress · done · cancelled
dueDatestringISO 8601
startDatestringISO 8601
internalbooleanHide from buyers
assigneesstring[]Emails — replaces current list
FieldTypeRequiredDescription
idstring✓Action item to delete

​
Workflows & webhooks

Triggers a configured automation.
FieldTypeRequiredDescription
workflowIdstring✓Workflow to trigger
dataobjectKey-value payload passed to the workflow

​
Lookups

FieldTypeRequiredDescription
sourcestringorg (default) or public
pagenumber
limitnumber
Searches by name or domain.
FieldTypeRequiredDescription
keywordstringName or domain (e.g. "Acme" or "acme.com")
pagenumber
limitnumber
FieldTypeRequiredDescription
domainstring✓Company domain (e.g. acme.com)
namestringDisplay name (defaults to domain)
websitestringFull website URL
Returns active users in the organization. Use returned IDs as userId when creating rooms.(No parameters)
Returns room statuses. Each result has id, title, and defaultStatus.(No parameters)
(No parameters)