List instance announcements
/api/announcementsThe messages sent or scheduled to the group's instances that are still open, newest first, at most 200, each with how it went. Read from Modbot's own tables; nothing here calls VRChat.
Needs the ViewLiveInstances permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/announcements"{ "announcements": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9", "title": "string", "message": "string", "state": "string", "sendAt": "2019-08-24T14:15:22Z", "timeZone": "string", "sentAt": null, "status": null, "error": null, "missingGroupPermission": null, "createdAt": "2019-08-24T14:15:22Z" } ], "canSend": true}Dismiss alert POST
Hide one alert's card. The alert itself is kept, and so is the fact it wrote. Needs the `ViewAnalytics` permission.
Send instance announcement POST
Sends a message to everyone in one of the group's open instances: the pop-up VRChat shows in the instance. `title` (at most 100 characters) and `message` (at most 500) are required, as plain text on one line: line breaks become spaces and other control characters are dropped. `when` is `now`, which asks VRChat in this request and answers with how it went (`sent`, `refused` with VRChat's status and words, or `failed`), or `later` with `sendAt` in `timeZone`, which Modbot sends once at that time. Never retried. Modbot's VRChat account needs Create Instance Announcement in the group; when the last group read says it lacks it, this answers 409 with `missingGroupPermission` and nothing is saved. The rate limit is a placeholder nobody has measured: one request every ten seconds. Needs the `ViewLiveInstances` and `AnnounceInInstances` permissions.