Create a group
curl --request POST \
--url https://api.example.com/groups \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"only_admin_publish": false,
"post_comments_enabled_default": true
}
'import requests
url = "https://api.example.com/groups"
payload = {
"name": "<string>",
"description": "<string>",
"only_admin_publish": False,
"post_comments_enabled_default": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
only_admin_publish: false,
post_comments_enabled_default: true
})
};
fetch('https://api.example.com/groups', 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",
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' => '<string>',
'description' => '<string>',
'only_admin_publish' => false,
'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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": false,\n \"post_comments_enabled_default\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/groups")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": false,\n \"post_comments_enabled_default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": false,\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
Create a group
Creates a new group and adds the authenticated user as an admin member.
POST
/
groups
Create a group
curl --request POST \
--url https://api.example.com/groups \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"only_admin_publish": false,
"post_comments_enabled_default": true
}
'import requests
url = "https://api.example.com/groups"
payload = {
"name": "<string>",
"description": "<string>",
"only_admin_publish": False,
"post_comments_enabled_default": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
only_admin_publish: false,
post_comments_enabled_default: true
})
};
fetch('https://api.example.com/groups', 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",
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' => '<string>',
'description' => '<string>',
'only_admin_publish' => false,
'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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": false,\n \"post_comments_enabled_default\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/groups")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": false,\n \"post_comments_enabled_default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"only_admin_publish\": false,\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
}
}
}Body
application/json
Name of the group
Group visibility type
Available options:
public, private Optional description of the group
If true, only group admins are allowed to publish posts in this group.
Whether comments are enabled by default on new posts in this group.
Response
Group created.
Show child attributes
Show child attributes
⌘I