Create a group

POST 
/admin/groups.json

Create a group

Request

application/json

Body

group objectrequired
name stringrequired
full_name stringrequired
bio_raw stringrequired
About Group
usernames stringrequired
comma,separated
owner_usernames stringrequired
comma,separated
automatic_membership_email_domains stringrequired
pipe|separated
visibility_level integerrequired
primary_group booleanrequired
flair_icon stringrequired
flair_upload_id integerrequired
flair_bg_color stringrequired
public_admission booleanrequired
public_exit booleanrequired
default_notification_level integerrequired
muted_category_ids integer[]required
regular_category_ids integer[]required
watching_category_ids integer[]required
tracking_category_ids integer[]required
watching_first_post_category_ids integer[]required

Responses

200

group created

application/json

Schema

Schema

basic_group objectrequired
id integerrequired
automatic booleanrequired
name stringrequired
user_count integerrequired
mentionable_level integerrequired
messageable_level integerrequired
visibility_level integerrequired
primary_group booleanrequired
title stringnullrequired
grant_trust_level stringnullrequired
incoming_email stringnullrequired
has_messages booleanrequired
flair_url stringnullrequired
flair_bg_color stringnullrequired
flair_color stringnullrequired
bio_raw stringnullrequired
bio_cooked stringnullrequired
bio_excerpt stringnullrequired
public_admission booleanrequired
public_exit booleanrequired
allow_membership_requests booleanrequired
full_name stringnullrequired
default_notification_level integerrequired
membership_request_template stringnullrequired
members_visibility_level integerrequired
can_see_members booleanrequired
can_admin_group booleanrequired
can_edit_group booleanrequired
publish_read_state booleanrequired

Example (from schema)

{
  "basic_group": {
    "id": 0,
    "automatic": true,
    "name": "string",
    "user_count": 0,
    "mentionable_level": 0,
    "messageable_level": 0,
    "visibility_level": 0,
    "primary_group": true,
    "has_messages": true,
    "public_admission": true,
    "public_exit": true,
    "allow_membership_requests": true,
    "default_notification_level": 0,
    "members_visibility_level": 0,
    "can_see_members": true,
    "can_admin_group": true,
    "can_edit_group": true,
    "publish_read_state": true
  }
}

Loading...