Modbot Docs
APIAPI referenceAnnouncements

Send instance announcement

POST/api/announcements

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.

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

curl -X POST "https://example.com/api/announcements" \  -H "Content-Type: application/json" \  -d '{    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",    "title": null,    "message": null  }'
{  "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"}

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.