v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Edits a Group post

Edits a Group post

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

PUT
/groups/{groupId}/posts/{notificationId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

notificationIdstring

Must be a valid notification ID.

Request Body

titlestring

Post title

Length1 <= length
textstring

Post text

Length1 <= length
imageId?string
sendNotificationboolean

Send notification to group members.

Defaultfalse
roleIds?GroupRoleIDList
visibilitystring
Value in"group" | "public"

Response Body

application/json

application/json

application/json

curl -X PUT "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000/posts/string" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Event is starting soon!",
    "text": "Come join us for the event!",
    "sendNotification": false,
    "visibility": "public"
  }'
{
  "id": "not_00000000-0000-0000-0000-000000000000",
  "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "editorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "visibility": "public",
  "roleId": [
    "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
  ],
  "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
  }
}

{
  "success": {
    "message": "Group Post was deleted!",
    "status_code": 200
  }
}