{"id":18061,"date":"2018-08-24T12:08:39","date_gmt":"2018-08-24T12:08:39","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15194"},"modified":"2021-03-25T07:35:28","modified_gmt":"2021-03-25T07:35:28","slug":"bot-variables-import","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/bot-variables-import\/","title":{"rendered":"Bot Variables Import API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Imports global and content variables into the bot.<\/p>\n

To use this API, app needs the Bot Builder API scope of Import Variables<\/em>.<\/p>\n

POST<\/strong> https:\/\/{{host}}\/api\/{{version}}\/public\/builder\/stream\/{{BotID}}\/variables\/import<\/code><\/i><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/td>\nBot ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
key<\/td>\nName of the Variable<\/td>\n<\/tr>\n
value<\/td>\nValue for the variable<\/td>\n<\/tr>\n
hint<\/td>\nDescription of the variable<\/td>\n<\/tr>\n
variableType<\/td>\nType of variable can be<\/p>\n
    \n
  • env<\/strong> for global variable or<\/li>\n
  • locale<\/strong> for content variable<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
scope<\/td>\nScope of the variable corresponds to the Setup Option at the time of variable declaration and can be<\/p>\n
    \n
  • prePopulated,<\/li>\n
  • askOnInstall, or<\/li>\n
  • hidden<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
localeData<\/td>\nFor variables of type locale, additional language data needs to be passed in the following format for each language:<\/p>\n
{\r\n      \"en\": {\r\n        \"value\": \"english language prompt\",\r\n        \"hint\": \"\"\r\n      }\r\n    }<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Authorization<\/span><\/h3>\n
Invoke the API with JWT in the header with the following syntax:<\/p>\n
auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Response content type<\/span><\/h3>\n
application\/JSON<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Request<\/span><\/h3>\n
curl -X POST \\\r\n  https:\/\/{{host}}\/api\/1.1\/public\/builder\/stream\/{{BotId}}\/variables\/import \\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -d '[\r\n  {\r\n    \"key\": \"Global\",\r\n    \"value\": \"Globalkey-prePopulated\",\r\n    \"hint\": \"\",\r\n    \"variableType\": \"env\",\r\n    \"scope\": \"prePopulated\"\r\n  },\r\n\t{\r\n    \"key\": \"Lang\",\r\n    \"variableType\": \"locale\",\r\n    \"scope\": \"prePopulated\",\r\n    \"localeData\": {\r\n      \"en\": {\r\n        \"value\": \"english language prompt\",\r\n        \"hint\": \"\"\r\n      }\r\n    }\r\n  }\r\n]'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n  \"message\": \"2 Variables imported\/updated successfully.\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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\/stream\/{{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...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18061","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18061","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=18061"}],"version-history":[{"count":7,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18061\/revisions"}],"predecessor-version":[{"id":26893,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18061\/revisions\/26893"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18061"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18061"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18061"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}