v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Create a calendar event

Creates an event for a group on the calendar

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

POST
/calendar/{groupId}/event

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Request Body

titlestring

Event title

Length1 <= length
startsAtstring

Time the event starts at

Formatdate-time
descriptionstring
Length1 <= length
endsAtstring

Time the event ends at

Formatdate-time
categorystring
tags?array<string>
isDraft?boolean
imageId?string
roleIds?array<string>
parentId?string
platforms?array<string>
languages?array<string>
sendCreationNotificationboolean

Send notification to group members.

featured?boolean
hostEarlyJoinMinutes?integer
guestEarlyJoinMinutes?integer
closeInstanceAfterEndMinutes?integer
usesInstanceOverflow?boolean
accessTypestring
Value in"public" | "group"

Response Body

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/calendar/grp_00000000-0000-0000-0000-000000000000/event" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Performance Event!",
    "startsAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "endsAt": "2019-08-24T14:15:22Z",
    "category": "performance",
    "sendCreationNotification": false,
    "accessType": "public"
  }'
{
  "accessType": "group",
  "category": "performance",
  "closeInstanceAfterEndMinutes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "endsAt": "2019-08-24T14:15:22Z",
  "featured": true,
  "guestEarlyJoinMinutes": 0,
  "hostEarlyJoinMinutes": 0,
  "id": "cal_6b182f0c-61ef-4bdf-97fe-94f63bcba27b",
  "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
  "imageUrl": "string",
  "interestedUserCount": 0,
  "isDraft": true,
  "languages": [
    "string"
  ],
  "ownerId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "platforms": [
    "string"
  ],
  "roleIds": [
    "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
  ],
  "startsAt": "2019-08-24T14:15:22Z",
  "tags": [
    "string"
  ],
  "title": "string",
  "type": "event",
  "updatedAt": "2019-08-24T14:15:22Z",
  "usesInstanceOverflow": true,
  "userInterest": {
    "createdAt": "2019-08-24T14:15:22Z",
    "isFollowing": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}