Groups

Update a group

PUT

https://discourse.example.com/groups/{id}.json

Update a group

curl -X PUT 'https://discourse.example.com/groups/0.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/groups/0.json', {
  method: 'PUT',
  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.put(
    'https://discourse.example.com/groups/0.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

{
  "success": "OK"
}

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>

Parameters

idintegerrequiredpath

Response

200OKany

success response

Response fields application/json

successstringrequired

Example

OK

Docs by Sourcey