curl --request POST \
--url https://api.partoo.co/v2/messaging/settings/{setting_id} \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"welcome_message": "<string>",
"offline_message": "<string>",
"uses_business_hours": true,
"custom_chat_hours": {
"monday": [
"10:00-14:00"
],
"tuesday": [
"10:00-14:00"
],
"wednesday": [
"10:00-14:00"
],
"thursday": [
"10:00-14:00"
],
"friday": [
"10:00-14:00"
],
"saturday": [
"10:00-14:00"
],
"sunday": [
"10:00-14:00"
]
},
"is_launched": true
}
'import requests
url = "https://api.partoo.co/v2/messaging/settings/{setting_id}"
payload = {
"welcome_message": "<string>",
"offline_message": "<string>",
"uses_business_hours": True,
"custom_chat_hours": {
"monday": ["10:00-14:00"],
"tuesday": ["10:00-14:00"],
"wednesday": ["10:00-14:00"],
"thursday": ["10:00-14:00"],
"friday": ["10:00-14:00"],
"saturday": ["10:00-14:00"],
"sunday": ["10:00-14:00"]
},
"is_launched": True
}
headers = {
"x-APIKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
welcome_message: '<string>',
offline_message: '<string>',
uses_business_hours: true,
custom_chat_hours: {
monday: ['10:00-14:00'],
tuesday: ['10:00-14:00'],
wednesday: ['10:00-14:00'],
thursday: ['10:00-14:00'],
friday: ['10:00-14:00'],
saturday: ['10:00-14:00'],
sunday: ['10:00-14:00']
},
is_launched: true
})
};
fetch('https://api.partoo.co/v2/messaging/settings/{setting_id}', 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.partoo.co/v2/messaging/settings/{setting_id}",
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([
'welcome_message' => '<string>',
'offline_message' => '<string>',
'uses_business_hours' => true,
'custom_chat_hours' => [
'monday' => [
'10:00-14:00'
],
'tuesday' => [
'10:00-14:00'
],
'wednesday' => [
'10:00-14:00'
],
'thursday' => [
'10:00-14:00'
],
'friday' => [
'10:00-14:00'
],
'saturday' => [
'10:00-14:00'
],
'sunday' => [
'10:00-14:00'
]
],
'is_launched' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-APIKey: <api-key>"
],
]);
$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.partoo.co/v2/messaging/settings/{setting_id}"
payload := strings.NewReader("{\n \"welcome_message\": \"<string>\",\n \"offline_message\": \"<string>\",\n \"uses_business_hours\": true,\n \"custom_chat_hours\": {\n \"monday\": [\n \"10:00-14:00\"\n ],\n \"tuesday\": [\n \"10:00-14:00\"\n ],\n \"wednesday\": [\n \"10:00-14:00\"\n ],\n \"thursday\": [\n \"10:00-14:00\"\n ],\n \"friday\": [\n \"10:00-14:00\"\n ],\n \"saturday\": [\n \"10:00-14:00\"\n ],\n \"sunday\": [\n \"10:00-14:00\"\n ]\n },\n \"is_launched\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-APIKey", "<api-key>")
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.partoo.co/v2/messaging/settings/{setting_id}")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"welcome_message\": \"<string>\",\n \"offline_message\": \"<string>\",\n \"uses_business_hours\": true,\n \"custom_chat_hours\": {\n \"monday\": [\n \"10:00-14:00\"\n ],\n \"tuesday\": [\n \"10:00-14:00\"\n ],\n \"wednesday\": [\n \"10:00-14:00\"\n ],\n \"thursday\": [\n \"10:00-14:00\"\n ],\n \"friday\": [\n \"10:00-14:00\"\n ],\n \"saturday\": [\n \"10:00-14:00\"\n ],\n \"sunday\": [\n \"10:00-14:00\"\n ]\n },\n \"is_launched\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/messaging/settings/{setting_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"welcome_message\": \"<string>\",\n \"offline_message\": \"<string>\",\n \"uses_business_hours\": true,\n \"custom_chat_hours\": {\n \"monday\": [\n \"10:00-14:00\"\n ],\n \"tuesday\": [\n \"10:00-14:00\"\n ],\n \"wednesday\": [\n \"10:00-14:00\"\n ],\n \"thursday\": [\n \"10:00-14:00\"\n ],\n \"friday\": [\n \"10:00-14:00\"\n ],\n \"saturday\": [\n \"10:00-14:00\"\n ],\n \"sunday\": [\n \"10:00-14:00\"\n ]\n },\n \"is_launched\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"business_id": "<string>",
"business_name": "<string>",
"business_address": "1 Rue de la Paix, 75000 Paris",
"welcome_message": "<string>",
"offline_message": "<string>",
"uses_business_hours": true,
"custom_chat_hours": {
"monday": [
"10:00-14:00"
],
"tuesday": [
"10:00-14:00"
],
"wednesday": [
"10:00-14:00"
],
"thursday": [
"10:00-14:00"
],
"friday": [
"10:00-14:00"
],
"saturday": [
"10:00-14:00"
],
"sunday": [
"10:00-14:00"
]
},
"is_launched": true
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Update messaging settings
This endpoint lets you update a specific Messaging Settings.
curl --request POST \
--url https://api.partoo.co/v2/messaging/settings/{setting_id} \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"welcome_message": "<string>",
"offline_message": "<string>",
"uses_business_hours": true,
"custom_chat_hours": {
"monday": [
"10:00-14:00"
],
"tuesday": [
"10:00-14:00"
],
"wednesday": [
"10:00-14:00"
],
"thursday": [
"10:00-14:00"
],
"friday": [
"10:00-14:00"
],
"saturday": [
"10:00-14:00"
],
"sunday": [
"10:00-14:00"
]
},
"is_launched": true
}
'import requests
url = "https://api.partoo.co/v2/messaging/settings/{setting_id}"
payload = {
"welcome_message": "<string>",
"offline_message": "<string>",
"uses_business_hours": True,
"custom_chat_hours": {
"monday": ["10:00-14:00"],
"tuesday": ["10:00-14:00"],
"wednesday": ["10:00-14:00"],
"thursday": ["10:00-14:00"],
"friday": ["10:00-14:00"],
"saturday": ["10:00-14:00"],
"sunday": ["10:00-14:00"]
},
"is_launched": True
}
headers = {
"x-APIKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
welcome_message: '<string>',
offline_message: '<string>',
uses_business_hours: true,
custom_chat_hours: {
monday: ['10:00-14:00'],
tuesday: ['10:00-14:00'],
wednesday: ['10:00-14:00'],
thursday: ['10:00-14:00'],
friday: ['10:00-14:00'],
saturday: ['10:00-14:00'],
sunday: ['10:00-14:00']
},
is_launched: true
})
};
fetch('https://api.partoo.co/v2/messaging/settings/{setting_id}', 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.partoo.co/v2/messaging/settings/{setting_id}",
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([
'welcome_message' => '<string>',
'offline_message' => '<string>',
'uses_business_hours' => true,
'custom_chat_hours' => [
'monday' => [
'10:00-14:00'
],
'tuesday' => [
'10:00-14:00'
],
'wednesday' => [
'10:00-14:00'
],
'thursday' => [
'10:00-14:00'
],
'friday' => [
'10:00-14:00'
],
'saturday' => [
'10:00-14:00'
],
'sunday' => [
'10:00-14:00'
]
],
'is_launched' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-APIKey: <api-key>"
],
]);
$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.partoo.co/v2/messaging/settings/{setting_id}"
payload := strings.NewReader("{\n \"welcome_message\": \"<string>\",\n \"offline_message\": \"<string>\",\n \"uses_business_hours\": true,\n \"custom_chat_hours\": {\n \"monday\": [\n \"10:00-14:00\"\n ],\n \"tuesday\": [\n \"10:00-14:00\"\n ],\n \"wednesday\": [\n \"10:00-14:00\"\n ],\n \"thursday\": [\n \"10:00-14:00\"\n ],\n \"friday\": [\n \"10:00-14:00\"\n ],\n \"saturday\": [\n \"10:00-14:00\"\n ],\n \"sunday\": [\n \"10:00-14:00\"\n ]\n },\n \"is_launched\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-APIKey", "<api-key>")
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.partoo.co/v2/messaging/settings/{setting_id}")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"welcome_message\": \"<string>\",\n \"offline_message\": \"<string>\",\n \"uses_business_hours\": true,\n \"custom_chat_hours\": {\n \"monday\": [\n \"10:00-14:00\"\n ],\n \"tuesday\": [\n \"10:00-14:00\"\n ],\n \"wednesday\": [\n \"10:00-14:00\"\n ],\n \"thursday\": [\n \"10:00-14:00\"\n ],\n \"friday\": [\n \"10:00-14:00\"\n ],\n \"saturday\": [\n \"10:00-14:00\"\n ],\n \"sunday\": [\n \"10:00-14:00\"\n ]\n },\n \"is_launched\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/messaging/settings/{setting_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"welcome_message\": \"<string>\",\n \"offline_message\": \"<string>\",\n \"uses_business_hours\": true,\n \"custom_chat_hours\": {\n \"monday\": [\n \"10:00-14:00\"\n ],\n \"tuesday\": [\n \"10:00-14:00\"\n ],\n \"wednesday\": [\n \"10:00-14:00\"\n ],\n \"thursday\": [\n \"10:00-14:00\"\n ],\n \"friday\": [\n \"10:00-14:00\"\n ],\n \"saturday\": [\n \"10:00-14:00\"\n ],\n \"sunday\": [\n \"10:00-14:00\"\n ]\n },\n \"is_launched\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"business_id": "<string>",
"business_name": "<string>",
"business_address": "1 Rue de la Paix, 75000 Paris",
"welcome_message": "<string>",
"offline_message": "<string>",
"uses_business_hours": true,
"custom_chat_hours": {
"monday": [
"10:00-14:00"
],
"tuesday": [
"10:00-14:00"
],
"wednesday": [
"10:00-14:00"
],
"thursday": [
"10:00-14:00"
],
"friday": [
"10:00-14:00"
],
"saturday": [
"10:00-14:00"
],
"sunday": [
"10:00-14:00"
]
},
"is_launched": true
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Authorizations
The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.
Path Parameters
The id of the Messaging Settings to update
Body
Request body to update a Post
When a consumer first contacts the business, an automated reply is sent.
The content of the reply depends on whether the consumer contacted the business during it's chat hours.
If it is, the welcome_message is sent as a reply.
The welcome_message is mandatory, and can be customized. A default will be set if none is specified.
When a consumer first contacts the business, an automated reply is sent.
The content of the reply depends on whether the consumer contacted the business during it's chat hours.
If it is not, the offline_message is sent as a reply.
The offline_message is mandatory, and can be customized. A default will be set if none is specified.
If set to true, the business' "open_hours" will be used as chat hours.
Otherwise, you need to specify "custom_chat_hours".
The chat hours of the business (in its timezone).
Chat hours are specified per weekday. This is done by supplying an object mapping weekdays ("monday", "tuesday", etc.) to a list of strings. These strings in turn represent time slots during which the business is open.
For example, the following value would set the chat hours to between 08:00-15:00 in the afternoon and 18:00-23:00 in the evening on Mondays:
{"monday": ["08:00-15:00", "18:00-23:00"]}
To indicate that a business can be contacted for 24 hours, for a specific weekday, use the value ["00:00-23:59"].
This field is not mandatory unless "uses_business_hours" is set to false.
Show child attributes
Show child attributes
Some messaging channels (Google and Facebook) can be temporarily deactivated. This allows the business to close for a period of time without having to answer consumer messages.
This is important because consumers will get frustrated if they are able to contact a business and do not get an answer. It is also important to note that for some messaging channels, not responding to messages may lead to decreased visibility of the business, or suspension of the messaging service.
The is_launched property indicates whether the business is reachable for those messaging channels.
The value can be updated, and the changes will be propagated to the messaging channels, effectively toggling the On or Off the ability for consumers to reach the business. (The change to "is_launched" is made asychronously, and the update will be effective when the messaging channels have finished propagating the information)
Response
OK
The ID of the business that the MessagingSetting is related to.
The Name of the business that the MessagingSetting is related to.
The Formatted address of the business that the MessagingSetting isrelated to.
"1 Rue de la Paix, 75000 Paris"
When a consumer first contacts the business, an automated reply is sent.
The content of the reply depends on whether the consumer contacted the business during it's chat hours.
If it is, the welcome_message is sent as a reply.
The welcome_message is mandatory, and can be customized. A default will be set if none is specified.
When a consumer first contacts the business, an automated reply is sent.
The content of the reply depends on whether the consumer contacted the business during it's chat hours.
If it is not, the offline_message is sent as a reply.
The offline_message is mandatory, and can be customized. A default will be set if none is specified.
If set to true, the business' "open_hours" will be used as chat hours.
Otherwise, you need to specify "custom_chat_hours".
The chat hours of the business (in its timezone).
Chat hours are specified per weekday. This is done by supplying an object mapping weekdays ("monday", "tuesday", etc.) to a list of strings. These strings in turn represent time slots during which the business is open.
For example, the following value would set the chat hours to between 08:00-15:00 in the afternoon and 18:00-23:00 in the evening on Mondays:
{"monday": ["08:00-15:00", "18:00-23:00"]}
To indicate that a business can be contacted for 24 hours, for a specific weekday, use the value ["00:00-23:59"].
This field is not mandatory unless "uses_business_hours" is set to false.
Show child attributes
Show child attributes
Some messaging channels (Google and Facebook) can be temporarily deactivated. This allows the business to close for a period of time without having to answer consumer messages.
This is important because consumers will get frustrated if they are able to contact a business and do not get an answer. It is also important to note that for some messaging channels, not responding to messages may lead to decreased visibility of the business, or suspension of the messaging service.
The is_launched property indicates whether the business is reachable for those messaging channels.
The value can be updated, and the changes will be propagated to the messaging channels, effectively toggling the On or Off the ability for consumers to reach the business. (The change to "is_launched" is made asychronously, and the update will be effective when the messaging channels have finished propagating the information)
Was this page helpful?