Groups

Create a group

POST

https://discourse.example.com/admin/groups.json

Create a group

curl -X POST 'https://discourse.example.com/admin/groups.json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "group": {
    "name": "string",
    "full_name": "string",
    "bio_raw": "string",
    "usernames": "string",
    "owner_usernames": "string",
    "automatic_membership_email_domains": "string",
    "visibility_level": 0,
    "primary_group": true,
    "flair_icon": "string",
    "flair_upload_id": 0,
    "flair_bg_color": "string",
    "public_admission": true,
    "public_exit": true,
    "default_notification_level": 0,
    "muted_category_ids": [
      0
    ],
    "regular_category_ids": [
      0
    ],
    "watching_category_ids": [
      0
    ],
    "tracking_category_ids": [
      0
    ],
    "watching_first_post_category_ids": [
      0
    ]
  }
}'

const body = `{
  "group": {
    "name": "string",
    "full_name": "string",
    "bio_raw": "string",
    "usernames": "string",
    "owner_usernames": "string",
    "automatic_membership_email_domains": "string",
    "visibility_level": 0,
    "primary_group": true,
    "flair_icon": "string",
    "flair_upload_id": 0,
    "flair_bg_color": "string",
    "public_admission": true,
    "public_exit": true,
    "default_notification_level": 0,
    "muted_category_ids": [
      0
    ],
    "regular_category_ids": [
      0
    ],
    "watching_category_ids": [
      0
    ],
    "tracking_category_ids": [
      0
    ],
    "watching_first_post_category_ids": [
      0
    ]
  }
}`;

const response = await fetch('https://discourse.example.com/admin/groups.json', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "group": {
    "name": "string",
    "full_name": "string",
    "bio_raw": "string",
    "usernames": "string",
    "owner_usernames": "string",
    "automatic_membership_email_domains": "string",
    "visibility_level": 0,
    "primary_group": true,
    "flair_icon": "string",
    "flair_upload_id": 0,
    "flair_bg_color": "string",
    "public_admission": true,
    "public_exit": true,
    "default_notification_level": 0,
    "muted_category_ids": [
      0
    ],
    "regular_category_ids": [
      0
    ],
    "watching_category_ids": [
      0
    ],
    "tracking_category_ids": [
      0
    ],
    "watching_first_post_category_ids": [
      0
    ]
  }
}'''

response = requests.post(
    'https://discourse.example.com/admin/groups.json',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "group": {
    "name": "string",
    "full_name": "string",
    "bio_raw": "string",
    "usernames": "string",
    "owner_usernames": "string",
    "automatic_membership_email_domains": "string",
    "visibility_level": 0,
    "primary_group": true,
    "flair_icon": "string",
    "flair_upload_id": 0,
    "flair_bg_color": "string",
    "public_admission": true,
    "public_exit": true,
    "default_notification_level": 0,
    "muted_category_ids": [
      0
    ],
    "regular_category_ids": [
      0
    ],
    "watching_category_ids": [
      0
    ],
    "tracking_category_ids": [
      0
    ],
    "watching_first_post_category_ids": [
      0
    ]
  }
}

200

{
  "basic_group": {
    "id": 0,
    "automatic": true,
    "name": "string",
    "user_count": 0,
    "mentionable_level": 0,
    "messageable_level": 0,
    "visibility_level": 0,
    "primary_group": true,
    "title": "string",
    "grant_trust_level": "string",
    "incoming_email": "string",
    "has_messages": true,
    "flair_url": "string",
    "flair_bg_color": "string",
    "flair_color": "string",
    "bio_raw": "string",
    "bio_cooked": "string",
    "bio_excerpt": "string",
    "public_admission": true,
    "public_exit": true,
    "allow_membership_requests": true,
    "full_name": "string",
    "default_notification_level": 0,
    "membership_request_template": "string",
    "members_visibility_level": 0,
    "can_see_members": true,
    "can_admin_group": true,
    "can_edit_group": true,
    "publish_read_state": true
  }
}

Body

application/json

groupobjectrequired

Show child attributes

namestringrequired

full_namestring

bio_rawstring

About Group

usernamesstring

comma,separated

owner_usernamesstring

comma,separated

automatic_membership_email_domainsstring

pipe|separated

visibility_levelinteger

primary_groupboolean

flair_iconstring

flair_upload_idinteger

flair_bg_colorstring

public_admissionboolean

public_exitboolean

default_notification_levelinteger

muted_category_idsArray<integer>

regular_category_idsArray<integer>

watching_category_idsArray<integer>

tracking_category_idsArray<integer>

watching_first_post_category_idsArray<integer>

Response

200OKany

group created

Response fields application/json

basic_groupobjectrequired

Show child attributes

idintegerrequired

automaticbooleanrequired

namestringrequired

user_countintegerrequired

mentionable_levelintegerrequired

messageable_levelintegerrequired

visibility_levelintegerrequired

primary_groupbooleanrequired

titlestring | nullrequired

grant_trust_levelstring | nullrequired

incoming_emailstring | nullrequired

has_messagesbooleanrequired

flair_urlstring | nullrequired

flair_bg_colorstring | nullrequired

flair_colorstring | nullrequired

bio_rawstring | nullrequired

bio_cookedstring | nullrequired

bio_excerptstring | nullrequired

public_admissionbooleanrequired

public_exitbooleanrequired

allow_membership_requestsbooleanrequired

full_namestring | nullrequired

default_notification_levelintegerrequired

membership_request_templatestring | nullrequired

members_visibility_levelintegerrequired

can_see_membersbooleanrequired

can_admin_groupbooleanrequired

can_edit_groupboolean

publish_read_statebooleanrequired

Docs by Sourcey