Update Group and set businesses
curl --request POST \
--url https://api.partoo.co/v2/sections/{section_id}/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"name": "France",
"business__in": [
"5409c35a97bbc544d8e26737",
"595badaef348ab6b3530033f",
"59d53302b12ff6429f262639"
]
}
'import requests
url = "https://api.partoo.co/v2/sections/{section_id}/groups/{group_id}"
payload = {
"name": "France",
"business__in": ["5409c35a97bbc544d8e26737", "595badaef348ab6b3530033f", "59d53302b12ff6429f262639"]
}
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({
name: 'France',
business__in: [
'5409c35a97bbc544d8e26737',
'595badaef348ab6b3530033f',
'59d53302b12ff6429f262639'
]
})
};
fetch('https://api.partoo.co/v2/sections/{section_id}/groups/{group_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/sections/{section_id}/groups/{group_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([
'name' => 'France',
'business__in' => [
'5409c35a97bbc544d8e26737',
'595badaef348ab6b3530033f',
'59d53302b12ff6429f262639'
]
]),
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/sections/{section_id}/groups/{group_id}"
payload := strings.NewReader("{\n \"name\": \"France\",\n \"business__in\": [\n \"5409c35a97bbc544d8e26737\",\n \"595badaef348ab6b3530033f\",\n \"59d53302b12ff6429f262639\"\n ]\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/sections/{section_id}/groups/{group_id}")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"France\",\n \"business__in\": [\n \"5409c35a97bbc544d8e26737\",\n \"595badaef348ab6b3530033f\",\n \"59d53302b12ff6429f262639\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/sections/{section_id}/groups/{group_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 \"name\": \"France\",\n \"business__in\": [\n \"5409c35a97bbc544d8e26737\",\n \"595badaef348ab6b3530033f\",\n \"59d53302b12ff6429f262639\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"id": 1
}{
"errors": {
"json": {
"name": "name_already_exists"
}
}
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Groups and Sections
Update Group and set businesses
Update a group.
This endpoint allows you to modify the details of an existing group within the system. Only Group Managers and higher roles can use this endpoint. Business Managers are restricted from accessing it. For more information about the group system, see the Groups and Sections description.
⚠️ You must specify which businesses are part of the group using the business__in parameter.
- If you don’t specify any businesses, the group will be updated to include all businesses. - To update a group to be empty, provide an empty array in the
business__inparameter.
POST
/
sections
/
{section_id}
/
groups
/
{group_id}
Update Group and set businesses
curl --request POST \
--url https://api.partoo.co/v2/sections/{section_id}/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"name": "France",
"business__in": [
"5409c35a97bbc544d8e26737",
"595badaef348ab6b3530033f",
"59d53302b12ff6429f262639"
]
}
'import requests
url = "https://api.partoo.co/v2/sections/{section_id}/groups/{group_id}"
payload = {
"name": "France",
"business__in": ["5409c35a97bbc544d8e26737", "595badaef348ab6b3530033f", "59d53302b12ff6429f262639"]
}
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({
name: 'France',
business__in: [
'5409c35a97bbc544d8e26737',
'595badaef348ab6b3530033f',
'59d53302b12ff6429f262639'
]
})
};
fetch('https://api.partoo.co/v2/sections/{section_id}/groups/{group_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/sections/{section_id}/groups/{group_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([
'name' => 'France',
'business__in' => [
'5409c35a97bbc544d8e26737',
'595badaef348ab6b3530033f',
'59d53302b12ff6429f262639'
]
]),
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/sections/{section_id}/groups/{group_id}"
payload := strings.NewReader("{\n \"name\": \"France\",\n \"business__in\": [\n \"5409c35a97bbc544d8e26737\",\n \"595badaef348ab6b3530033f\",\n \"59d53302b12ff6429f262639\"\n ]\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/sections/{section_id}/groups/{group_id}")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"France\",\n \"business__in\": [\n \"5409c35a97bbc544d8e26737\",\n \"595badaef348ab6b3530033f\",\n \"59d53302b12ff6429f262639\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/sections/{section_id}/groups/{group_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 \"name\": \"France\",\n \"business__in\": [\n \"5409c35a97bbc544d8e26737\",\n \"595badaef348ab6b3530033f\",\n \"59d53302b12ff6429f262639\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"id": 1
}{
"errors": {
"json": {
"name": "name_already_exists"
}
}
}{
"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.
Body
application/json
Was this page helpful?