v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Create Group Announcement

Creates an Announcement for a Group. Warning: This will also remove all announcements. To make proper announcements, use the posts endpoint instead

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

POST
/groups/{groupId}/announcement

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Request Body

titlestring

Announcement title

Length1 <= length
text?string

Announcement text

Length1 <= length
imageId?string
sendNotification?boolean

Send notification to group members.

Defaultfalse

Response Body

application/json

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000/announcement" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Event is starting soon!"
  }'
{
  "id": "gpos_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "title": "string",
  "text": "string",
  "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
  "imageUrl": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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

{
  "error": {
    "message": "Can't find groupǃ",
    "status_code": 404
  }
}