Chatbots
Publish automated chat flows that can answer, qualify, and hand over.
10 generated endpoints in this resource group.
get
/chatbotsList chatbots#
Returns chatbot drafts and active automations for the workspace.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:list
Allowed roles
- owner
- admin
- agent
List chatbots in the workspace.
Optional parameters
- Name
pageSize- Type
- query integer
- Description
- Values above 100 are reduced to 100; 0 or omitted uses the default (50).
- Name
pageToken- Type
- query string
- Description
- Optional parameter.
Responses
- Name
200- Type
- application/json
- Description
- List of chatbots
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
GETRequest
curl -G "https://api.flownally.com/v1/chatbots" \
-H "Authorization: Bearer {token}" \
-d pageSize="{pageSize}" \
-d pageToken="{pageToken}"Response
200application/json
{
"chatbots": [
{
"id": "cbt_d7piv2pmo0bkvp4lmeh0",
"name": "Support triage",
"status": "draft",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
],
"createdAt": "2026-04-30T10:00:00Z",
"updatedAt": "2026-04-30T10:12:00Z"
}
],
"nextPageToken": "string",
"totalSize": 0
}post
/chatbotsCreate chatbot#
Creates a chatbot draft that can later be published and activated.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:create
Allowed roles
- owner
- admin
- agent
Create a chatbot in the workspace.
Request body
Send a application/json body. The body is required for this operation.
Required attributes
- Name
name- Type
- string
- Description
- Required request attribute.
Optional attributes
- Name
teamIds- Type
- array<string>
- Description
- Initial team assignments. Omit or empty for tenant-wide fallback.
- Name
draft- Type
- ChatbotWorkflowDefinition
- Description
- Optional request attribute.
Responses
- Name
201- Type
- application/json
- Description
- Chatbot created
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"name": "Support triage",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
]
}'Response
201application/json
{
"id": "cbt_d7piv2pmo0bkvp4lmeh0",
"name": "Support triage",
"status": "draft",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
],
"createdAt": "2026-04-30T10:00:00Z",
"updatedAt": "2026-04-30T10:12:00Z"
}get
/chatbots/{id}Get chatbot#
Returns a chatbot draft, its status, and the active version when one is running.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:read
Allowed roles
- owner
- admin
- agent
Read a chatbot in the workspace.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Responses
- Name
200- Type
- application/json
- Description
- Chatbot details
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
GETRequest
curl -X GET "https://api.flownally.com/v1/chatbots/{id}" \
-H "Authorization: Bearer {token}"Response
200application/json
{
"id": "cbt_d7piv2pmo0bkvp4lmeh0",
"name": "Support triage",
"status": "draft",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
],
"createdAt": "2026-04-30T10:00:00Z",
"updatedAt": "2026-04-30T10:12:00Z"
}patch
/chatbots/{id}Update chatbot#
Updates chatbot draft details or team assignments. Publish again to snapshot changes. Changing the teams of an active chatbot fails when another active chatbot already serves one of the new teams, or when no teams remain and another active chatbot already serves the whole workspace.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:update
Allowed roles
- owner
- admin
- agent
Update a chatbot in the workspace.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Request body
Send a application/json body. The body is required for this operation.
Optional attributes
- Name
name- Type
- string
- Description
- Optional request attribute.
- Name
teamIds- Type
- array<string>
- Description
- Replaces the full set of team assignments when provided. Omit to leave assignments unchanged. Pass an empty array to clear all assignments (making this the tenant-wide fallback bot).
- Name
draft- Type
- ChatbotWorkflowDefinition
- Description
- Optional request attribute.
Responses
- Name
200- Type
- application/json
- Description
- Chatbot updated
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
PATCHRequest
curl -X PATCH "https://api.flownally.com/v1/chatbots/{id}" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"name": "order_ready",
"teamIds": [
"string"
],
"draft": {
"nodes": [
{
"id": "string",
"type": "string",
"data": {}
}
],
"edges": [
{}
]
}
}'Response
200application/json
{
"id": "cbt_d7piv2pmo0bkvp4lmeh0",
"name": "Support triage",
"status": "draft",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
],
"createdAt": "2026-04-30T10:00:00Z",
"updatedAt": "2026-04-30T10:12:00Z"
}delete
/chatbots/{id}Delete chatbot#
Deletes a chatbot. Active chatbots must be paused first.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:delete
Allowed roles
- owner
- admin
- agent
Delete a chatbot in the workspace.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Responses
- Name
204- Description
- Chatbot deleted
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
DELETERequest
curl -X DELETE "https://api.flownally.com/v1/chatbots/{id}" \
-H "Authorization: Bearer {token}"Response
204
204 Chatbot deletedpost
/chatbots/{id}:publishPublish chatbot#
Validates and snapshots the current draft definition as an immutable version.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:publish
Allowed roles
- owner
- admin
- agent
Publish a chatbot version.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Responses
- Name
200- Type
- application/json
- Description
- Version published
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots/{id}:publish" \
-H "Authorization: Bearer {token}"Response
200application/json
{
"id": "string",
"chatbotId": "string",
"definition": {
"nodes": [
{
"id": "string",
"type": "string",
"data": {}
}
],
"edges": [
{}
]
},
"createdAt": "2026-04-27T00:00:00.000Z",
"updatedAt": "2026-04-27T00:00:00.000Z"
}post
/chatbots/{id}:activateActivate chatbot#
Activates a chatbot. Requires a published version. Fails while another active chatbot serves one of its teams, or the whole workspace when it has no teams; pause that chatbot first.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:activate
Allowed roles
- owner
- admin
- agent
Activate a chatbot.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Responses
- Name
200- Type
- application/json
- Description
- Chatbot activated
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots/{id}:activate" \
-H "Authorization: Bearer {token}"Response
200application/json
{
"id": "cbt_d7piv2pmo0bkvp4lmeh0",
"name": "Support triage",
"status": "draft",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
],
"createdAt": "2026-04-30T10:00:00Z",
"updatedAt": "2026-04-30T10:12:00Z"
}post
/chatbots/{id}:pausePause chatbot#
Pauses an active chatbot.
Authorization
Scheme
- bearerAuth
Required scopes
- journey:activate
Allowed roles
- owner
- admin
- agent
Pause a chatbot.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Responses
- Name
200- Type
- application/json
- Description
- Chatbot paused
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots/{id}:pause" \
-H "Authorization: Bearer {token}"Response
200application/json
{
"id": "cbt_d7piv2pmo0bkvp4lmeh0",
"name": "Support triage",
"status": "draft",
"teamIds": [
"tem_d7pi77577990sq67vgqg"
],
"createdAt": "2026-04-30T10:00:00Z",
"updatedAt": "2026-04-30T10:12:00Z"
}get
/chatbots/{id}/versionsList chatbot versions#
Authorization
Scheme
- bearerAuth
Required scopes
- journey:read
Allowed roles
- owner
- admin
- agent
List chatbot versions.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
Optional parameters
- Name
pageSize- Type
- query integer
- Description
- Values above 100 are reduced to 100; 0 or omitted uses the default (50).
- Name
pageToken- Type
- query string
- Description
- Optional parameter.
Responses
- Name
200- Type
- application/json
- Description
- List of versions
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
GETRequest
curl -G "https://api.flownally.com/v1/chatbots/{id}/versions" \
-H "Authorization: Bearer {token}" \
-d pageSize="{pageSize}" \
-d pageToken="{pageToken}"Response
200application/json
{
"chatbotVersions": [
{
"id": "string",
"chatbotId": "string",
"definition": {
"nodes": [
{
"id": "string",
"type": "string",
"data": {}
}
],
"edges": [
{}
]
},
"createdAt": "2026-04-27T00:00:00.000Z",
"updatedAt": "2026-04-27T00:00:00.000Z"
}
],
"nextPageToken": "string",
"totalSize": 0
}get
/chatbots/{id}/versions/{versionId}Get chatbot version#
Authorization
Scheme
- bearerAuth
Required scopes
- journey:read
Allowed roles
- owner
- admin
- agent
Read a chatbot version.
Required parameters
- Name
id- Type
- path string
- Description
- Required parameter.
- Name
versionId- Type
- path string
- Description
- Required parameter.
Responses
- Name
200- Type
- application/json
- Description
- Version details
- Name
default- Type
- application/json
- Description
- Error
Related schemas
Request
GETRequest
curl -X GET "https://api.flownally.com/v1/chatbots/{id}/versions/{versionId}" \
-H "Authorization: Bearer {token}"Response
200application/json
{
"id": "string",
"chatbotId": "string",
"definition": {
"nodes": [
{
"id": "string",
"type": "string",
"data": {}
}
],
"edges": [
{}
]
},
"createdAt": "2026-04-27T00:00:00.000Z",
"updatedAt": "2026-04-27T00:00:00.000Z"
}