{"id":18061,"date":"2018-08-24T12:08:39","date_gmt":"2018-08-24T12:08:39","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15194"},"modified":"2023-07-25T11:47:50","modified_gmt":"2023-07-25T10:47:50","slug":"bot-variables-import","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/bot-variables-import\/","title":{"rendered":"Bot Variables Import API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To import global and content variables into the bot.<\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/{{version}}\/public\/builder\/bot\/{{BotID}}\/variables\/import<\/code><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Import Variables<\/li>\n
  • Admin Console: Not Applicable<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    host<\/td>\nRequired<\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\n<\/tr>\n
    BotID<\/td>\nRequired<\/td>\nThe identifier can be accessed under General Settings<\/b> on the Bot Builder.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n

    Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    key<\/td>\nRequired<\/td>\nName of the variable.<\/td>\n<\/tr>\n
    value<\/td>\nRequired<\/td>\nValue for the variable.<\/td>\n<\/tr>\n
    hint<\/td>\nRequired<\/td>\nDescription of the variable.<\/td>\n<\/tr>\n
    variableType<\/td>\nRequired<\/td>\nThe type of variable can be as follows:<\/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>\nRequired<\/td>\nThe scope of the variable corresponds to the Setup<\/b> Option at the time of variable declaration and can be one of the following:<\/p>\n
      \n
    • prePopulated<\/li>\n
    • askOnInstall<\/li>\n
    • hidden<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    localeData<\/td>\nRequired<\/td>\nFor the 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
     <\/p>\n
    Sample Request<\/span><\/h2>\n
    curl -X POST \\\r\n  https:\/\/{{host}}\/api\/1.1\/public\/builder\/bot\/{{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
     <\/p>\n
    Sample Request when Collections are enabled<\/span><\/h2>\n
    curl -X POST \\\r\n  https:\/\/{{host}}\/api\/1.1\/public\/builder\/bot\/{{BotId}}\/variables\/import \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n--header 'Content-Type: application\/json' \\\r\n--data-raw '{\r\n    \"botVariables\": [\r\n        {\r\n            \"key\": \"CVar\",\r\n            \"value\": \"Cvar1\",\r\n            \"hint\": \"\",\r\n            \"audioTag\": \"\",\r\n            \"variableType\": \"locale\",\r\n            \"scope\": \"prePopulated\",\r\n            \"localeData\": {\r\n                \"en\": {\r\n                    \"value\": \"Cvar1\",\r\n                    \"hint\": \"\",\r\n                    \"audioTag\": \"\"\r\n                }\r\n            },\r\n            \"group\": \"\",\r\n            \"propagateValue\": false,\r\n            \"vNameSpace\": [\r\n                {\r\n                    \"name\": \"default\",\r\n                    \"refId\": \"10xxxxxx-4xxb-50xx-bxx9-3axxxxxxxxxx\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"key\": \"GKey1\",\r\n            \"value\": \"GValue1-C\",\r\n            \"hint\": \"GNotes1\",\r\n            \"audioTag\": \"\",\r\n            \"variableType\": \"env\",\r\n            \"scope\": \"prePopulated\",\r\n            \"group\": \"\",\r\n            \"propagateValue\": false,\r\n            \"vNameSpace\": [\r\n                {\r\n                    \"name\": \"default\",\r\n                    \"refId\": \"10xxxxxx-4xxb-50xx-bxx9-3axxxxxxxxxx\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"key\": \"GKey2\",\r\n            \"value\": \"Gkey2Stag\",\r\n            \"hint\": \"GNotes2\",\r\n            \"audioTag\": \"\",\r\n            \"variableType\": \"env\",\r\n            \"scope\": \"prePopulated\",\r\n            \"group\": \"\",\r\n            \"propagateValue\": false,\r\n            \"vNameSpace\": [\r\n                {\r\n                    \"name\": \"default\",\r\n                    \"refId\": \"10xxxxxx-4xxb-50xx-bxx9-3axxxxxxxxxx\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"key\": \"GKey55\",\r\n            \"value\": \"GKey55-Staging\",\r\n            \"hint\": \"GNotes2\",\r\n            \"audioTag\": \"\",\r\n            \"variableType\": \"env\",\r\n            \"scope\": \"prePopulated\",\r\n            \"propagateValue\": false,\r\n            \"vNameSpace\": [\r\n                {\r\n                    \"name\": \"default\",\r\n                    \"refId\": \"10xxxxxx-4xxb-50xx-bxx9-3axxxxxxxxxx\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"key\": \"contentvar\",\r\n            \"value\": \"contvarvalue\",\r\n            \"hint\": \"This is content variable\",\r\n            \"audioTag\": \"\",\r\n            \"variableType\": \"locale\",\r\n            \"scope\": \"prePopulated\",\r\n            \"localeData\": {\r\n                \"en\": {\r\n                    \"value\": \"contvarvalue\",\r\n                    \"hint\": \"This is content variable\",\r\n                    \"audioTag\": \"\"\r\n                }\r\n            },\r\n            \"group\": \"\",\r\n            \"propagateValue\": false,\r\n            \"vNameSpace\": [\r\n                {\r\n                    \"name\": \"default\",\r\n                    \"refId\": \"10xxxxxx-4xxb-50xx-bxx9-3axxxxxxxxxx\"\r\n                }\r\n            ]\r\n        }\r\n    ],\r\n    \"botCollections\": [\r\n        {\r\n            \"name\": \"Default\",\r\n            \"description\": \"Default Collection\",\r\n            \"refId\": \"8xxxxxxa-exxc-5xx1-bxxd-56xxxxxxxxxx\"\r\n        },\r\n        {\r\n            \"name\": \"Staging\",\r\n            \"description\": \"Staging Environment\",\r\n            \"refId\": \"0cxxxxx1-3xx8-52xx-bxxc-02xxxxxxxxxx\"\r\n        }\r\n    ],\r\n    \"botCollectionVariables\": [\r\n        {\r\n            \"key\": \"GKey1\",\r\n            \"value\": \"GValue1-C\",\r\n            \"audioTag\": \"\",\r\n            \"refId\": \"0cxxxxx1-3xx8-52xx-bxxc-02xxxxxxxxxx\"\r\n        },\r\n        {\r\n            \"key\": \"GKey1\",\r\n            \"value\": \"GValue1-C\",\r\n            \"audioTag\": \"\",\r\n            \"refId\": \"8xxxxxxa-exxc-5xx1-bxxd-56xxxxxxxxxx\"\r\n        },\r\n        {\r\n            \"key\": \"GKey2\",\r\n            \"value\": \"Gkey2Stag\",\r\n            \"audioTag\": \"\",\r\n            \"refId\": \"0cxxxxx1-3xx8-52xx-bxxc-02xxxxxxxxxx\"\r\n        },\r\n        {\r\n            \"key\": \"GKey2\",\r\n            \"value\": \"Gkey2Diff\",\r\n            \"audioTag\": \"\",\r\n            \"refId\": \"8xxxxxxa-exxc-5xx1-bxxd-56xxxxxxxxxx\"\r\n        },\r\n        {\r\n            \"key\": \"GKey55\",\r\n            \"value\": \"GKey55-Staging\",\r\n            \"audioTag\": \"\",\r\n            \"refId\": \"0cxxxxx1-3xx8-52xx-bxxc-02xxxxxxxxxx\"\r\n        },\r\n        {\r\n            \"key\": \"GKey55\",\r\n            \"value\": \"GKey55-Default\",\r\n            \"audioTag\": \"testaudioTag\",\r\n            \"refId\": \"8xxxxxxa-exxc-5xx1-bxxd-56xxxxxxxxxx\"\r\n        }\r\n    ]\r\n}'<\/pre>\n
     <\/p>\n
    Body Parameters<\/span><\/h2>\n
    No body parameters are passed.<\/p>\n
     <\/p>\n
    Sample Response<\/span><\/h2>\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":"To import global and content variables into the bot. Method POST Endpoint https:\/\/{{host}}\/api\/{{version}}\/public\/builder\/bot\/{{BotID}}\/variables\/import Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Import Variables Admin Console: Not Applicable   Query Parameters Parameter Required Description host Required The environment URL. For example, https:\/\/bots.kore.ai BotID Required The identifier can...","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\/v10-1\/wp-json\/wp\/v2\/posts\/18061","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18061"}],"version-history":[{"count":19,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18061\/revisions"}],"predecessor-version":[{"id":58360,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18061\/revisions\/58360"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18061"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18061"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18061"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}