Modbot Docs
APIAPI referenceGroup page

Invite to the group

POST/api/group/invites

Invite one person to the group on VRChat. userId names them; displayName is kept in the audit log. At most one invite goes out every thirty seconds across the deployment, auto-invites included: sooner answers 429 with Retry-After. One request, never retried; a refusal answers with what VRChat said. Once VRChat accepts, the audit log records who sent it, on the invited person's history. It counts as an invite Modbot sent, so auto-invites wait as long before inviting the same person as they would after one of their own.

Needs the ManageGroupInvites 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/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/group/invites" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'
Empty

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.