GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. Update User API

Update User API

To update the user details.

This API requires JWT generated by an application created only from the Bot Admin Console.
This feature was introduced in ver7.1 of the platform.

Method PUT
Endpoint https://{{host}}/api/public/users
Content Type application/json
Authorization

auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: User Management > User Management

 

Path Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

 

Sample Request

curl -X PUT \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>,
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": {
                "addTo": [
                    "e-f9c09c08-9310-52ff-b672-570ec7325215"
                ]
            },
            "roles": {
                "addTo": [
                    {
                        "roleId": "5d9d8db3x0d54920a8df1e68b",
                        "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                    }
                ],
                "removeFrom": [
                    {
                        "roleId": "5d9d920dabdc1e6e8ec99342",
                        "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                    }
                ]
            },
            "assignBotTasks": [
               {
                  "botId": "st-xxx-xx-xxx-xxx-xxxx",
                  "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
                 }
      	       ],
            "canCreateBot": true,
            "isDeveloper": true
        }
	]
}
'

 

Body Parameters

Parameter Required/Optional Description
users Required The array of details for each user that need to be updated.
Sub-parameters

userInfo.emailId

or userInfo.orgUserId

Required Email Ids or the org user id of the user being updated
userInfo.firstName Optional First name of the user if needs to be updated
userInfo.lastName Optional Last name of the user if needs to be updated
userInfo.companyName Optional Company to which the user if needs to be updated
userInfo.dept Optional Department to which the user if needs to be updated
userInfo.companyContactPhone Optional Contact Phone of the Company to which the user belongs if needs to be updated
userInfo.worknumber Optional Work number of the user if needs to be updated
userInfo.street Optional Street Address of the user if needs to be updated
userInfo.suiteNo Optional Suite No Address of the user if needs to be updated
userInfo.city Optional City Address of the user if needs to be updated
userInfo.zip Optional Zip Address of the user if needs to be updated
userInfo.state Optional State Address of the user if needs to be updated
userInfo.country Optional Country Address of the user if needs to be updated
groups Optional array of group ids to which the user needs to be addTo or removeFrom
roles Optional array of roleId-botId combinations to which the user needs to be addTo or removeFrom
assignBotTasks Optional

array of bots that have to be assigned to the user. If not present, the current assignment will be retained.

botId Id of the Bot to be assigned to the user. If not given, all the previous assigned bots will be unassigned. That is, an entry for “assignBotTasks” without “botId” entry can be used to unassign the Bot tasks to the user.
dialogs Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned
canCreateBot Optional Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
Default value is “true”.
isDeveloper Optional Determines if the specified users can have access to Bot Builder. Set to true or false.
Default value is “true”.

 

Sample Response

    • For success case:
      {
              "msg": "Users are updated Successfully"
          }

Update User API

To update the user details.

This API requires JWT generated by an application created only from the Bot Admin Console.
This feature was introduced in ver7.1 of the platform.

Method PUT
Endpoint https://{{host}}/api/public/users
Content Type application/json
Authorization

auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: User Management > User Management

 

Path Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

 

Sample Request

curl -X PUT \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>,
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": {
                "addTo": [
                    "e-f9c09c08-9310-52ff-b672-570ec7325215"
                ]
            },
            "roles": {
                "addTo": [
                    {
                        "roleId": "5d9d8db3x0d54920a8df1e68b",
                        "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                    }
                ],
                "removeFrom": [
                    {
                        "roleId": "5d9d920dabdc1e6e8ec99342",
                        "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                    }
                ]
            },
            "assignBotTasks": [
               {
                  "botId": "st-xxx-xx-xxx-xxx-xxxx",
                  "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
                 }
      	       ],
            "canCreateBot": true,
            "isDeveloper": true
        }
	]
}
'

 

Body Parameters

Parameter Required/Optional Description
users Required The array of details for each user that need to be updated.
Sub-parameters

userInfo.emailId

or userInfo.orgUserId

Required Email Ids or the org user id of the user being updated
userInfo.firstName Optional First name of the user if needs to be updated
userInfo.lastName Optional Last name of the user if needs to be updated
userInfo.companyName Optional Company to which the user if needs to be updated
userInfo.dept Optional Department to which the user if needs to be updated
userInfo.companyContactPhone Optional Contact Phone of the Company to which the user belongs if needs to be updated
userInfo.worknumber Optional Work number of the user if needs to be updated
userInfo.street Optional Street Address of the user if needs to be updated
userInfo.suiteNo Optional Suite No Address of the user if needs to be updated
userInfo.city Optional City Address of the user if needs to be updated
userInfo.zip Optional Zip Address of the user if needs to be updated
userInfo.state Optional State Address of the user if needs to be updated
userInfo.country Optional Country Address of the user if needs to be updated
groups Optional array of group ids to which the user needs to be addTo or removeFrom
roles Optional array of roleId-botId combinations to which the user needs to be addTo or removeFrom
assignBotTasks Optional

array of bots that have to be assigned to the user. If not present, the current assignment will be retained.

botId Id of the Bot to be assigned to the user. If not given, all the previous assigned bots will be unassigned. That is, an entry for “assignBotTasks” without “botId” entry can be used to unassign the Bot tasks to the user.
dialogs Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned
canCreateBot Optional Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
Default value is “true”.
isDeveloper Optional Determines if the specified users can have access to Bot Builder. Set to true or false.
Default value is “true”.

 

Sample Response

    • For success case:
      {
              "msg": "Users are updated Successfully"
          }
Menu