Modbot Docs
APIAPI referenceGroup page

Update group profile

PUT/api/group/profile

Change the group's name, description, rules, languages, links or who can join, on VRChat. Leave a field out (or null) to keep it. Only the fields that differ from what Modbot stored are sent, and nothing is sent when none do. Limits are VRChat's: a name of 3 to 64 characters, a description of up to 250, at most 3 languages (VRChat's codes, such as eng) and at most 3 http or https links. joinState is open, request, invite or closed. One request to VRChat, never retried: a refusal answers with VRChat's own message, a rate limit with 429. Once VRChat accepts, the change is written to the audit log with who made it and each field's old and new value, and the answer is the group as the page now shows it.

Needs the EditGroupProfile permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/api/group/profile" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": null,  "name": null,  "shortCode": null,  "discriminator": null,  "iconUrl": null,  "bannerUrl": null,  "description": null,  "rules": null,  "languages": [    "string"  ],  "links": [    "string"  ],  "joinState": null,  "members": null,  "online": null,  "countedAt": null,  "readAt": null,  "generatedAt": "2019-08-24T14:15:22Z"}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.