Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Update a group​

Update group properties like name, description, URL, avatar, country, or privacy. Group privacy can be Public, Closed, or Private. Only group admins/owners can update.

Request Body required

Group fields to update - all fields optional except id

    public boolean nullable deprecated

    Deprecated content-visibility projection. Use privacy instead.

    id number required
    name string

    Possible values: non-empty and <= 50 characters

    description string

    Possible values: <= 200 characters

    url string

    Possible values: non-empty and <= 50 characters

    removeAvatar boolean
    avatar string

    Possible values: Value must match regular expression /^data:image\/[a-z]+;base64,/

    country string nullable
    privacy string nullable

    Possible values: [public, closed, private]

    hideFollowJoinButton boolean nullable
Responses

Group updated successfully

Schema
    success boolean
    room object
Loading...