Preview calendar event
/api/calendar/previewThe event as it is filled in, drawn the way each place would show it: the Discord event and the channel post as Discord is sent them, what VRChat's calendar is sent, and what a calendar program reads from the calendar feed. Drawn by the code that sends each one. Saves nothing and asks VRChat and Discord nothing. A title, description, channel or world not filled in yet is let through; anything a save would refuse for its shape or length is refused.
Needs the ManageCalendar 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/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/calendar/preview" \ -H "Content-Type: application/json" \ -d '{ "eventId": null, "event": { "title": "string", "description": null, "startsAt": "string", "endsAt": "string", "timeZone": "string", "repeat": null, "repeatDays": null, "repeatUntil": null, "worldId": null, "accessType": null, "region": null, "imageUrl": null, "vrChatImageId": null, "category": null, "languages": null, "platforms": null, "tags": null, "visibility": null, "notifyMembers": true, "publishToVRChat": true, "publishToDiscord": true, "postToChannel": true, "channelId": null, "autoOpen": true, "openMinutesBefore": null, "draft": true } }'{ "discordEvent": null, "channelPost": null, "vrChat": { "update": true, "title": "string", "description": "string", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "category": null, "visibility": null, "languages": [ "string" ], "platforms": [ "string" ], "tags": [ "string" ], "imageId": null, "repeat": null, "notify": true, "featured": false }, "feed": { "calendarName": "string", "title": "string", "notes": null, "location": null, "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "timeZone": "string", "repeat": null }, "google": null, "bluesky": null}Try a place again POST
Send a failed place of an event again, as it is, without editing the event: place is vrchat, discordEvent, channelPost, cancelPost or googleCalendar, and the place has canTryAgain. With plannedStartsAt, one date of a repeating event whose own change to VRChat's calendar or Google Calendar failed. A VRChat event that got no answer and was not on VRChat's calendar is looked for once more before it is sent, and a Google event whose insert got no answer is read back first. Sent on the next pass; the place says waiting until then. 409 when there is no failure to try again, as on a second press. The body may be left out. Needs the `ManageCalendar` permission.
Upload VRChat calendar picture POST
Uploads a picture to VRChat, on the VRChat account Modbot signs in as, for an event's entry on VRChat's calendar. Needs Manage calendar or Manage templates, because the template editor keeps one too. The body is the picture itself: a PNG or JPEG of at most 10 MB, told apart by its first bytes rather than its Content-Type. Answers with the file id VRChat gave it; save that as the event's vrChatImageId. eventId names the event when it is already saved, for the audit log. One request to VRChat, at most one a minute and never retried; a picture that is too big or not a PNG or JPEG is refused before VRChat is asked. Answers 409 "Picture uploads are off." until the operator turns uploads on in Settings, and 409 "Modbot's VRChat account needs VRChat+ to use pictures." while the account is known to have none; VRChat takes the upload only from an account with VRChat+. Modbot keeps none of the bytes. Needs the `ViewCalendar` permission.