Skip to main content
POST
/
groups
Create a group
curl --request POST \
  --url https://api.example.com/groups \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "public",
  "description": "<string>",
  "only_admin_publish": false,
  "post_comments_enabled_default": true
}
'
{
  "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
string
required

Name of the group

​
type
enum<string>
required

Group visibility type

Available options:
public,
private
​
description
string | null

Optional description of the group

​
only_admin_publish
boolean
default:false

If true, only group admins are allowed to publish posts in this group.

​
post_comments_enabled_default
boolean
default:true

Whether comments are enabled by default on new posts in this group.

Response

Group created.

​
data
object