Edit a group

Required OAuth scope: groups:write.

Edits specific fields of an existing group. Fields not included in the request payload remain unchanged.

Path Params
string
required

The unique ID of the group.

Body Params
string | null

A custom field to store information available only in the General settings of the group, the CSV exports, and the API. This information is not displayed to learners on the platform.

string
length ≥ 1

The name of the group.

boolean

True if the group is public; false if the group is private.

string

The unique ID of the parent group. It must not be the updated group or one of its descendants.

string | null

The banner image of the group. Ensure that given media is an image with the proper size (at least 980px wide and 370px high).

string | null

The background image of the group. Ensure that given media is an image with the proper size (at least 760px wide and 880px high).

string | null

The favicon image of the group. Ensure that given media is an image with the proper size (less than 500px wide and 500px high and more than 16px wide and 16px high).

string | null

The logo image of the group.

string | null

The subdomain of the group.

string | null

The custom url of the group.

privacyPolicy
object | null

The privacy policy of the group.

moderationCharter
object | null

The moderation charter of the group.

termsOfUse
object | null

The terms of use of the group.

imprint
object | null

The imprint of the group.

Headers
string
enum
required

The version of the API.

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json