curl --request POST \
--url https://api.livechatinc.com/v3.7/configuration/action/create_canned_response \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "Thank you for contacting us! How can I help you today?",
"tags": [
"greeting",
"support"
],
"group_id": 1,
"is_private": false
}
'import requests
url = "https://api.livechatinc.com/v3.7/configuration/action/create_canned_response"
payload = {
"text": "Thank you for contacting us! How can I help you today?",
"tags": ["greeting", "support"],
"group_id": 1,
"is_private": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: 'Thank you for contacting us! How can I help you today?',
tags: ['greeting', 'support'],
group_id: 1,
is_private: false
})
};
fetch('https://api.livechatinc.com/v3.7/configuration/action/create_canned_response', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.livechatinc.com/v3.7/configuration/action/create_canned_response",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'text' => 'Thank you for contacting us! How can I help you today?',
'tags' => [
'greeting',
'support'
],
'group_id' => 1,
'is_private' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.livechatinc.com/v3.7/configuration/action/create_canned_response"
payload := strings.NewReader("{\n \"text\": \"Thank you for contacting us! How can I help you today?\",\n \"tags\": [\n \"greeting\",\n \"support\"\n ],\n \"group_id\": 1,\n \"is_private\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.7/configuration/action/create_canned_response")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"Thank you for contacting us! How can I help you today?\",\n \"tags\": [\n \"greeting\",\n \"support\"\n ],\n \"group_id\": 1,\n \"is_private\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/configuration/action/create_canned_response")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"Thank you for contacting us! How can I help you today?\",\n \"tags\": [\n \"greeting\",\n \"support\"\n ],\n \"group_id\": 1,\n \"is_private\": false\n}"
response = http.request(request)
puts response.read_body{
"id": 12345
}Create canned response
Creates a new canned response.
The text field is sanitized on creation. If sanitization removes all content and the input becomes empty, the system rejects the request as invalid.
curl --request POST \
--url https://api.livechatinc.com/v3.7/configuration/action/create_canned_response \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "Thank you for contacting us! How can I help you today?",
"tags": [
"greeting",
"support"
],
"group_id": 1,
"is_private": false
}
'import requests
url = "https://api.livechatinc.com/v3.7/configuration/action/create_canned_response"
payload = {
"text": "Thank you for contacting us! How can I help you today?",
"tags": ["greeting", "support"],
"group_id": 1,
"is_private": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: 'Thank you for contacting us! How can I help you today?',
tags: ['greeting', 'support'],
group_id: 1,
is_private: false
})
};
fetch('https://api.livechatinc.com/v3.7/configuration/action/create_canned_response', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.livechatinc.com/v3.7/configuration/action/create_canned_response",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'text' => 'Thank you for contacting us! How can I help you today?',
'tags' => [
'greeting',
'support'
],
'group_id' => 1,
'is_private' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.livechatinc.com/v3.7/configuration/action/create_canned_response"
payload := strings.NewReader("{\n \"text\": \"Thank you for contacting us! How can I help you today?\",\n \"tags\": [\n \"greeting\",\n \"support\"\n ],\n \"group_id\": 1,\n \"is_private\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.7/configuration/action/create_canned_response")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"Thank you for contacting us! How can I help you today?\",\n \"tags\": [\n \"greeting\",\n \"support\"\n ],\n \"group_id\": 1,\n \"is_private\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/configuration/action/create_canned_response")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"Thank you for contacting us! How can I help you today?\",\n \"tags\": [\n \"greeting\",\n \"support\"\n ],\n \"group_id\": 1,\n \"is_private\": false\n}"
response = http.request(request)
puts response.read_body{
"id": 12345
}canned_responses_writeAuthorizations
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
The canned response text content. Sanitized on creation — if sanitization removes all content, the request is rejected as invalid.
An array of tags.
The ID of the group the canned response belongs to.
If set to true: the canned response will be private. If set to false: it will be public. Default: false.
Response
Canned response created successfully.
The ID of the created canned response.
Was this page helpful?