Imports global and content variables into the bot.
To use this API, app needs the Bot Builder API scope of Import Variables.
POST https://{{host}}/api/{{version}}/public/builder/bot/{{BotID}}/variables/import
Query Parameters
Parameter | Description |
---|---|
host | Environment URL, for example, https://bots.kore.ai |
BotID | Bot ID. You can access it from the General Settings page of the bot. |
Body Parameters
Parameter | Description |
---|---|
key | Name of the Variable |
value | Value for the variable |
hint | Description of the variable |
variableType | Type of variable can be
|
scope | Scope of the variable corresponds to the Setup Option at the time of variable declaration and can be
|
localeData | For variables of type locale, additional language data needs to be passed in the following format for each language:
{ "en": { "value": "english language prompt", "hint": "" } } |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response content type
application/JSON
Sample Request
curl -X POST \ https://{{host}}/api/1.1/public/builder/bot/{{BotId}}/variables/import \ -H 'Content-Type: application/json' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -d '[ { "key": "Global", "value": "Globalkey-prePopulated", "hint": "", "variableType": "env", "scope": "prePopulated" }, { "key": "Lang", "variableType": "locale", "scope": "prePopulated", "localeData": { "en": { "value": "english language prompt", "hint": "" } } } ]'
Sample Request when Collections are enabled
curl -X POST \ https://{{host}}/api/1.1/public/builder/bot/{{BotId}}/variables/import \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "botVariables": [ { "key": "CVar", "value": "Cvar1", "hint": "", "audioTag": "", "variableType": "locale", "scope": "prePopulated", "localeData": { "en": { "value": "Cvar1", "hint": "", "audioTag": "" } }, "group": "", "propagateValue": false, "vNameSpace": [ { "name": "default", "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017" } ] }, { "key": "GKey1", "value": "GValue1-C", "hint": "GNotes1", "audioTag": "", "variableType": "env", "scope": "prePopulated", "group": "", "propagateValue": false, "vNameSpace": [ { "name": "default", "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017" } ] }, { "key": "GKey2", "value": "Gkey2Stag", "hint": "GNotes2", "audioTag": "", "variableType": "env", "scope": "prePopulated", "group": "", "propagateValue": false, "vNameSpace": [ { "name": "default", "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017" } ] }, { "key": "GKey55", "value": "GKey55-Staging", "hint": "GNotes2", "audioTag": "", "variableType": "env", "scope": "prePopulated", "propagateValue": false, "vNameSpace": [ { "name": "default", "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017" } ] }, { "key": "contentvar", "value": "contvarvalue", "hint": "This is content variable", "audioTag": "", "variableType": "locale", "scope": "prePopulated", "localeData": { "en": { "value": "contvarvalue", "hint": "This is content variable", "audioTag": "" } }, "group": "", "propagateValue": false, "vNameSpace": [ { "name": "default", "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017" } ] } ], "botCollections": [ { "name": "Default", "description": "Default Collection", "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c" }, { "name": "Staging", "description": "Staging Environment", "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3" } ], "botCollectionVariables": [ { "key": "GKey1", "value": "GValue1-C", "audioTag": "", "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3" }, { "key": "GKey1", "value": "GValue1-C", "audioTag": "", "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c" }, { "key": "GKey2", "value": "Gkey2Stag", "audioTag": "", "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3" }, { "key": "GKey2", "value": "Gkey2Diff", "audioTag": "", "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c" }, { "key": "GKey55", "value": "GKey55-Staging", "audioTag": "", "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3" }, { "key": "GKey55", "value": "GKey55-Default", "audioTag": "testaudioTag", "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c" } ] }'
Sample Response
{ "message": "2 Variables imported/updated successfully." }