{"_id":"581b83f0f749100f00964ad0","__v":7,"user":"55aa7d625d3abb0d0012f3da","project":"55aa7d973be8f60d00041d42","version":{"_id":"55aa7d983be8f60d00041d45","__v":20,"project":"55aa7d973be8f60d00041d42","createdAt":"2015-07-18T16:23:52.273Z","releaseDate":"2015-07-18T16:23:52.273Z","categories":["55aa7d983be8f60d00041d46","55aacf4e3be8f60d00041d89","55aacfaae2bdcb0d00c7466e","55aacfb3e2bdcb0d00c7466f","55aacfca3be8f60d00041d8a","55b67da3f8105a2f00c351ab","55b7cae4aea7c8190058ba5b","55b9218afeef5135009b7db3","55c182616d7d2921006da013","5631407afa40240d007c8c60","56548b9c9c4c6d0d00aeda0c","572b9137ff3ba10e00b4abb4","572b9150ff3ba10e00b4abb5","581b83288ca41f0f007e4fb6","585065fa70cbe00f00835bb8","58641eba0355f31900380492","58861760b4816e19005c9941","58a316cb254c401b00a049ce","58ac80dbd5e1570f00d1c328","59f72b4991121a00104f036e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"581b83288ca41f0f007e4fb6","project":"55aa7d973be8f60d00041d42","version":"55aa7d983be8f60d00041d45","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-03T18:34:16.595Z","from_sync":false,"order":6,"slug":"chatbots","title":"ChatBots"},"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-03T18:37:36.924Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl 'https://api.cliengo.com/1.0/chatbots/<websiteId>?api_key=your_api_key' "},{"code":"def leadaki = new HTTPBuilder(http://www.api.leadaki.com/1.0/chatbots/<websiteId>?api_key=APIKEY)\ndef reqBody = [newTitle: 'Sales Chat', botName: 'Alejandro']\nleadaki.put(reqBody)","language":"groovy"}]},"method":"put","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"chatbotId\" : \"ID\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58502f5d7f4101390054092e","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"581b88a6bdfa410f0087c270","ref":"","in":"body","required":false,"desc":"Tells the bot how much to insist on getting a email (REQUIRED, NOTREQUIRED, OPTIONAL)","default":"REQUIRED","type":"string","name":"askEmail"},{"_id":"581b88a6bdfa410f0087c26f","ref":"","in":"body","required":false,"desc":"Tells the bot how much to insist on getting a ID/DNI (REQUIRED, NOTREQUIRED, OPTIONAL)","default":"NOTREQUIRED","type":"string","name":"askDni"},{"_id":"581b88a6bdfa410f0087c271","ref":"","in":"body","required":false,"desc":"Tells the bot how much to insist on getting a telephone (REQUIRED, NOTREQUIRED, OPTIONAL)","default":"REQUIRED","type":"string","name":"askTelephone"},{"_id":"581b88a6bdfa410f0087c261","ref":"","in":"body","required":false,"desc":"If set in true, after obtaining the client's phone, the bot will ask at which time they'd rather be called.","default":"false","type":"boolean","name":"askTimeToCall"},{"_id":"581b88a6bdfa410f0087c26d","ref":"","in":"body","required":false,"desc":"Additional question for when the flow finishes","default":"","type":"string","name":"question1"},{"_id":"581b88a6bdfa410f0087c26c","ref":"","in":"body","required":false,"desc":"Additional question for when the flow finishes","default":"","type":"string","name":"question2"},{"_id":"581b88a6bdfa410f0087c26b","ref":"","in":"body","required":false,"desc":"Additional question for when the flow finishes","default":"","type":"string","name":"question3"},{"_id":"581b88a6bdfa410f0087c266","ref":"","in":"body","required":false,"desc":"Defines what your bot says when someone asks for your company address.","default":"","type":"string","name":"addressAnswer"},{"_id":"581b88a6bdfa410f0087c267","ref":"","in":"body","required":false,"desc":"Defines what your bot says when someone asks for your company phone.","default":"","type":"string","name":"telephoneAnswer"},{"_id":"581b8d1ebdfa410f0087c277","ref":"","in":"body","required":false,"desc":"Customized bot answer for when it announces that you are chatting with a robot","default":"","type":"string","name":"isRobotAnswer"},{"_id":"581b88a6bdfa410f0087c265","ref":"","in":"body","required":false,"desc":"Defines what your bot says when it pops up (see saluteTime)","default":"","type":"string","name":"welcomeMessage"},{"_id":"581b88a6bdfa410f0087c264","ref":"","in":"body","required":false,"desc":"Defines what your bot says when someone asks for your company customer support time.","default":"","type":"string","name":"customerSupportTime"},{"_id":"58adb18175df0f1b001ed585","ref":"","in":"body","required":false,"desc":"An image URL or a base64 encoded image","default":"","type":"string","name":"profilePic"},{"_id":"581b88a6bdfa410f0087c26e","ref":"","in":"body","required":false,"desc":"Change chat color based on a hexadecimal color (Ex: 5BA0D0)","default":"5BA0D0","type":"string","name":"color"},{"_id":"581b88a6bdfa410f0087c26a","ref":"","in":"body","required":false,"desc":"Chat language (en, es, pt)","default":"es","type":"string","name":"language"},{"_id":"581b88a6bdfa410f0087c268","ref":"","in":"body","required":false,"desc":"Chatbot window title","default":"","type":"string","name":"newTitle"},{"_id":"581b88a6bdfa410f0087c263","ref":"","in":"body","required":false,"desc":"Your chatbot name.","default":"Pilar","type":"string","name":"name"},{"_id":"581b88a6bdfa410f0087c269","ref":"","in":"body","required":false,"desc":"Time until the chat pops on a website in seconds.","default":"15","type":"int","name":"saluteTime"},{"_id":"581b88a6bdfa410f0087c262","ref":"","in":"body","required":false,"desc":"Makes your bot answer/not answer when someone asks for your company customer support time.","default":"false","type":"boolean","name":"customerSupportTimeOn"},{"_id":"581b8d1ebdfa410f0087c276","ref":"","in":"body","required":false,"desc":"If set on true, the bot will reveal it's true self at the begging of the chat. (Will tell the user it's a chat bot and not a real operator)","default":"false","type":"boolean","name":"isRobotAnswerOn"}],"url":"/sites/:id/chatbot"},"isReference":false,"order":3,"body":"","excerpt":"Customize your ChatBot via API!","slug":"chat-bots","type":"endpoint","title":"/sites/:id/chatbot"}

put/sites/:id/chatbot

Customize your ChatBot via API!

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

Body Params

askEmail:
stringREQUIRED
Tells the bot how much to insist on getting a email (REQUIRED, NOTREQUIRED, OPTIONAL)
askDni:
stringNOTREQUIRED
Tells the bot how much to insist on getting a ID/DNI (REQUIRED, NOTREQUIRED, OPTIONAL)
askTelephone:
stringREQUIRED
Tells the bot how much to insist on getting a telephone (REQUIRED, NOTREQUIRED, OPTIONAL)
askTimeToCall:
booleanfalse
If set in true, after obtaining the client's phone, the bot will ask at which time they'd rather be called.
question1:
string
Additional question for when the flow finishes
question2:
string
Additional question for when the flow finishes
question3:
string
Additional question for when the flow finishes
addressAnswer:
string
Defines what your bot says when someone asks for your company address.
telephoneAnswer:
string
Defines what your bot says when someone asks for your company phone.
isRobotAnswer:
string
Customized bot answer for when it announces that you are chatting with a robot
welcomeMessage:
string
Defines what your bot says when it pops up (see saluteTime)
customerSupportTime:
string
Defines what your bot says when someone asks for your company customer support time.
profilePic:
string
An image URL or a base64 encoded image
color:
string5BA0D0
Change chat color based on a hexadecimal color (Ex: 5BA0D0)
language:
stringes
Chat language (en, es, pt)
newTitle:
string
Chatbot window title
name:
stringPilar
Your chatbot name.
saluteTime:
integer15
Time until the chat pops on a website in seconds.
customerSupportTimeOn:
booleanfalse
Makes your bot answer/not answer when someone asks for your company customer support time.
isRobotAnswerOn:
booleanfalse
If set on true, the bot will reveal it's true self at the begging of the chat. (Will tell the user it's a chat bot and not a real operator)

Examples


Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}