settings
Get settings of a client in a grouped way for a category
API Dokumentation
ticket
- GETGet next ticket id to work on
- POSTGet a list of tickets
- POSTCreate a ticket
- PATCHUpdate a few tickets at once
- GETGet a ticket
- PATCHUpdate a ticket
- GETGet ticket variables
- GETGet a tickets history
- POSTForward a ticket
- POSTAuto-execute a ticket
- GETPing a ticket
- GETGet ticket activity
- GETGet ticket stats
- GETGet agent queue status
customer
intent
aiAgent
- GETList of all available AI agents as an array
- GETList of all available AI agents as an tree based on associated tag
- POSTLoad enneo default AI Agents
- POSTCreate a new aiAgent
- GETGet an AI Agent by id
- DELDelete an existing AI Agent
- PATCHUpdate an existing AI Agent
- GETGet similar tickets for an AI Agent
- POSTPreview an AI Agent
- POSTGet the outcome of an AI Agent
aiQualityCheck
- GETGet all test runs with pagination
- POSTSchedule a new AI quality check
- GETGet a specific test run by ID
- DELDelete a specific test run by ID
- PATCHUpdate the expected result of a test ticket
- PATCHAccept the expected result of a test ticket
- POSTAccept ALL the expected results of for a test run
- GETGet all AI agents for which test runs can be triggered
- GETGet all AI agents for which test runs can be triggered
- GETGet test cases by AI agent ID
- POSTAdd test cases for an AI agent
- DELDelete a test case by ID
- PATCHUpdate a test case by ID
intentTemplate
profile
team
reminder
settings
- GETGet settings of a client
- POSTUpdate multiple settings at once
- GETGet settings of a client and return the results in a compact form
- GETGet settings of a client in a grouped way for a category
- PUTUpdate setting
- GETSearch settings
- GETGet Subchannels
- POSTAdd a new Subchannel
- DELDelete a Subchannel
- GETGet User Defined Functions
- POSTAdd a new User Defined Function
- DELDelete a User Defined Function
- GETRedirect to Microsoft authorization page
- GETCallback for Microsoft authorization
tag
cron
version
knowledgeSourceStructure
knowledgeSource
pcProxy
cortex
settings
Get settings of a client in a grouped way for a category
GET
/
settings
/
category
/
{category}
curl --request GET \
--url https://demo.enneo.ai/api/mind/settings/category/{category}
{
"title": "E-Mail Settings",
"groups": [
{
"name": "Generic E-Mail Settings",
"description": "You can configure your general email settings here",
"settings": [
{
"name": "ticketingSystem",
"category": "email",
"group": "Generic E-Mail Settings",
"label": "Ticketing system in use",
"description": "Enneo supports multiple ticketing systems. Please select one.",
"type": "select",
"config": null,
"value": "freshdesk",
"defaultValue": "internal"
}
]
}
]
}
Authorizations
Cookie-based authentication
Path Parameters
Filter by category of the setting
Response
200
application/json
List of client-specific configruation settings.
Group of settings.
Settings object
Format in which the FE should render this setting. Follows the enneo standard dynamic intent form options specified in Notion
Available options:
text
, date
, radio
, number
, integer
, checkbox
, textarea
, select
, json
, executor
, executors
, multiselect
Additional configuration properties that are dependant on type or rarely used
Information that the FE should render this field as a readonly
Information that this is sensitive information. Value will only be returned if the user has sufficient permissions, and if the query parameter showSecrets=true was provided
curl --request GET \
--url https://demo.enneo.ai/api/mind/settings/category/{category}
{
"title": "E-Mail Settings",
"groups": [
{
"name": "Generic E-Mail Settings",
"description": "You can configure your general email settings here",
"settings": [
{
"name": "ticketingSystem",
"category": "email",
"group": "Generic E-Mail Settings",
"label": "Ticketing system in use",
"description": "Enneo supports multiple ticketing systems. Please select one.",
"type": "select",
"config": null,
"value": "freshdesk",
"defaultValue": "internal"
}
]
}
]
}