Modbot Docs
APIAPI referencePartners

Update partner

PUT/api/partners/{id}

Replace everything known about a partner. A refusal (400) says what is wrong in error.

Needs the ManagePartners permission.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

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

curl -X PUT "https://example.com/api/partners/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": null,    "groupId": null,    "status": null,    "envoy": null,    "contacts": null,    "lastCollabOn": null,    "lastCollabNote": null,    "notes": null  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "groupId": null,  "status": "string",  "envoy": null,  "contacts": [    "string"  ],  "lastCollabOn": null,  "lastCollabNote": null,  "notes": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "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.

Delete partner DELETE

Delete a partner and everything known about it. Needs the `ManagePartners` permission.

List people GET

Every VRChat account Modbot has ever seen: members, people who left, people it only ever saw in an instance or in the audit log. `search` matches the display name and the id, case-insensitively and literally. `membership` is `member`, `not-member`, `left` or `all` (the default); `banned` is true or false for the group's ban list as it stands, `everBanned` true or false for a ban at any time, lifted or not; `profile` is `fetched` or `not-fetched`. `eighteenPlus` is true or false for Modbot's 18+ mark. `trustRank` is a trust rank name and may be repeated: people holding any of them, and never anybody whose tags have not been read. `platform` is the platform they last used, matched case-insensitively against whatever VRChat sent, and may be repeated. `linked=linked` shows only people with a linked Discord account and `linked=not-linked` only people without. `flagged` is true or false for having ever been flagged by a moderation rule, dismissed or not. `seenFrom` and `seenTo` narrow the list to people Modbot last saw inside that stretch. `role` is a group role id and may be repeated: people holding any of them; `notRole`, also repeatable, leaves out people holding any of those; `noRole=true` keeps only people with no role. `representing` is true or false. `joinedFrom` and `joinedTo` narrow the list to people who joined the group inside that stretch, which is what an unusual-activity alert links to. `instance` is a Modbot instance id: only people a moderator's client saw in that instance, each row with a `visit` (first arrival, last leave, how many visits). `hereAt` and `notHereAt`, repeatable and only with `instance`, keep people who were there at that moment, or were not; every one must hold. Sorted by when Modbot last saw them, most recent first, unless `sort=name`, `sort=known` (longest known first) or `sort=joined` (newest joiner first). With `instance`, the default is `sort=arrived` (first to arrive first) and `sort=left` puts the first to leave first. Names and pictures come from the profile sync and are null for anybody it has not fetched yet. Each row carries the member list's fields too: roles, when they joined, whether they are representing the group, and their linked Discord account. `roles` lists the group's roles with how many current members hold each. Needs See profiles. See members alone is enough for `membership=member` or `membership=left`, without `flagged` or `linked`; the rows then carry no linked Discord account. `instance` needs See analytics and See audit log instead of either, and still refuses `flagged` and `linked` without See profiles.