List messaging settings
curl --request GET \
--url https://api.partoo.co/v2/messaging/settings \
--header 'x-APIKey: <api-key>'import requests
url = "https://api.partoo.co/v2/messaging/settings"
headers = {"x-APIKey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-APIKey': '<api-key>'}};
fetch('https://api.partoo.co/v2/messaging/settings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.partoo.co/v2/messaging/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-APIKey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.partoo.co/v2/messaging/settings")
.header("x-APIKey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/messaging/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-APIKey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"settings": [
{
"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
}
],
"page": 1,
"count": 1,
"max_page": 1
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Messaging Settings
List messaging settings
This endpoint lets you list all the Messaging Settings you have access to.
You can filter the Messaging Settings based on the Organization or the Business that they are related to.
GET
/
messaging
/
settings
List messaging settings
curl --request GET \
--url https://api.partoo.co/v2/messaging/settings \
--header 'x-APIKey: <api-key>'import requests
url = "https://api.partoo.co/v2/messaging/settings"
headers = {"x-APIKey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-APIKey': '<api-key>'}};
fetch('https://api.partoo.co/v2/messaging/settings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.partoo.co/v2/messaging/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-APIKey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.partoo.co/v2/messaging/settings")
.header("x-APIKey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/messaging/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-APIKey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"settings": [
{
"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
}
],
"page": 1,
"count": 1,
"max_page": 1
}{
"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.
Query Parameters
Current page number.
Required range:
x >= 1Number of items to return per page.
Required range:
1 <= x <= 100Filter by business ids. Use a comma-separated list to provide multiple ids.
Example:
"a1c9f37b4deca92f83b61d02,9f4e2a8c0d73b154e621bc97,c73b15e9fa42d60b3a8c21ef"
Response
OK
Response object
Was this page helpful?