Update a group
curl --request PATCH \
--url https://api.example.com/groups/{group} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"only_admin_publish": true,
"post_comments_enabled_default": true
}
'import requests
url = "https://api.example.com/groups/{group}"
payload = {
"name": "<string>",
"description": "<string>",
"only_admin_publish": True,
"post_comments_enabled_default": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
only_admin_publish: true,
post_comments_enabled_default: true
})
};
fetch('https://api.example.com/groups/{group}', 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.example.com/groups/{group}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'only_admin_publish' => true,
'post_comments_enabled_default' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/groups/{group}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": true,\n \"post_comments_enabled_default\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/groups/{group}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": true,\n \"post_comments_enabled_default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/groups/{group}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": true,\n \"post_comments_enabled_default\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"content_type": "group",
"name": "Team Alpha",
"description": "<string>",
"type": "public",
"mute_rule": 123,
"has_unread_notifications": true,
"only_admin_publish": 123,
"post_comments_enabled_default": true,
"member": "<string>",
"image": {},
"auto": {},
"url": "api/groups/1",
"permissions": {
"member": "<string>",
"edit": true,
"delete": true
},
"publish": {
"updated_at": 123
},
"membership": {
"auto": true
},
"stats": {
"active": 123
}
}
}Groups
Update a group
Updates the basic details of an existing group.
PATCH
/
groups
/
{group}
Update a group
curl --request PATCH \
--url https://api.example.com/groups/{group} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"only_admin_publish": true,
"post_comments_enabled_default": true
}
'import requests
url = "https://api.example.com/groups/{group}"
payload = {
"name": "<string>",
"description": "<string>",
"only_admin_publish": True,
"post_comments_enabled_default": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
only_admin_publish: true,
post_comments_enabled_default: true
})
};
fetch('https://api.example.com/groups/{group}', 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.example.com/groups/{group}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'only_admin_publish' => true,
'post_comments_enabled_default' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/groups/{group}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": true,\n \"post_comments_enabled_default\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/groups/{group}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": true,\n \"post_comments_enabled_default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/groups/{group}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": true,\n \"post_comments_enabled_default\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"content_type": "group",
"name": "Team Alpha",
"description": "<string>",
"type": "public",
"mute_rule": 123,
"has_unread_notifications": true,
"only_admin_publish": 123,
"post_comments_enabled_default": true,
"member": "<string>",
"image": {},
"auto": {},
"url": "api/groups/1",
"permissions": {
"member": "<string>",
"edit": true,
"delete": true
},
"publish": {
"updated_at": 123
},
"membership": {
"auto": true
},
"stats": {
"active": 123
}
}
}Path Parameters
Group ID
Body
application/json
New group name
New group description
New group visibility type
Available options:
public, private If true, only admins can publish posts in the group.
Whether comments should be enabled by default on new posts.
Response
Updated group.
Show child attributes
Show child attributes
⌘I