Invite to the group
/api/group/invitesInvite 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.
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" }'List sent group invites GET
The people the group has invited on VRChat who have not answered yet, read from VRChat when you ask, newest first. `page` and `pageSize` page it (at most 100 a page); `hasMore` is true when the page came back full, because VRChat sends no total. One request to VRChat per call, never retried. Needs the `ManageGroupInvites` permission.
Cancel group invite POST
Take back the group's invite to one person on VRChat. `userId` names them; `displayName` is kept in the audit log, as the page showed it. One request, never retried. An invite VRChat no longer has answers 404. Once VRChat accepts, the audit log records who cancelled it, on the invited person's history. Needs the `ManageGroupInvites` permission.