Create Flow Folder
Create a folder for call flows or message flows in a workspace.
Headers
x-workspace-idstringrequiredThe workspace the folder belongs to. Folders and flows in other workspaces are treated as not found.
Request Body
namestringrequiredThe folder name (for example "Inbound Flows").
flowTypestringrequiredWhat the folder holds: call (call flows) or message (message flows). Can't be changed later.
colorstringAny string. It is stored and returned exactly as sent, with no validation or conversion, so send a hex color such as #3B82F6. Defaults to #3498db.
iconstringAny string, stored as sent. The portal uses folder, file, phone, headphone, voice and message. Defaults to folder.
Response (201 Created)
_idstringThe folder's unique identifier.
workspaceIdstringThe workspace the folder belongs to.
namestringThe folder name.
colorstringThe folder color, stored exactly as sent (default #3498db).
iconstringThe folder icon, stored exactly as sent (default folder).
flowTypestringcall or message.
pathwayModelstringPathway for call folders, MessagePathway for message folders. Set by the server from flowType.
pathwaysarrayAn empty array for a new folder.
createdAtstringWhen the folder was created (ISO 8601). Folders have no updatedAt.
Errors
All folder errors use a message field, not error.
| Status | Body | When |
|---|---|---|
400 | {"message": "x-workspace-id header is required"} | x-workspace-id missing or not a valid ID |
500 | {"message": "..."} | Unexpected server error |
{
"name": "Inbound Flows",
"flowType": "call",
"color": "#3B82F6",
"icon": "folder"
}{
"_id": "b2b2b2b2b2b2b2b2b2b2b2b2",
"workspaceId": "b4b4b4b4b4b4b4b4b4b4b4b4",
"name": "Inbound Flows",
"color": "#3B82F6",
"icon": "folder",
"flowType": "call",
"pathways": [],
"pathwayModel": "Pathway",
"createdAt": "2026-10-15T09:30:00.000Z",
"__v": 0
}Last updated on