VRChatBackendDocs/Apis/NotificationsApi.md

NotificationsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
acceptFriendRequest	PUT /auth/user/notifications/{notificationId}/accept	Accept Friend Request
acknowledgeNotificationV2	POST /notifications/{notificationId}/see	Acknowledge NotificationV2
clearNotifications	PUT /auth/user/notifications/clear	Clear All Notifications
deleteAllNotificationV2s	DELETE /notifications	Delete All NotificationV2s
deleteNotification	PUT /auth/user/notifications/{notificationId}/hide	Delete Notification
deleteNotificationV2	DELETE /notifications/{notificationId}	Delete NotificationV2
getNotification	GET /auth/user/notifications/{notificationId}	Show notification
getNotificationV2	GET /notifications/{notificationId}	Get NotificationV2
getNotificationV2s	GET /notifications	List NotificationV2s
getNotifications	GET /auth/user/notifications	List Notifications
markNotificationAsRead	PUT /auth/user/notifications/{notificationId}/see	Mark Notification As Read
replyNotificationV2	POST /notifications/{notificationId}/reply	Reply NotificationV2
respondNotificationV2	POST /notifications/{notificationId}/respond	Respond NotificationV2

acceptFriendRequest

Success acceptFriendRequest(notificationId)

Accept Friend Request

Accept a friend request by notification `frq_` ID. Friend requests can be found using the NotificationsAPI `getNotifications` by filtering of type `friendRequest`.

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

acknowledgeNotificationV2

NotificationV2 acknowledgeNotificationV2(notificationId)

Acknowledge NotificationV2

Acknowledge a specific notification

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

NotificationV2

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

clearNotifications

Success clearNotifications()

Clear All Notifications

Clear **all** notifications.

Parameters

This endpoint does not need any parameter.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteAllNotificationV2s

Success deleteAllNotificationV2s()

Delete All NotificationV2s

Delete all of the current user's notifications.

Parameters

This endpoint does not need any parameter.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteNotification

Notification deleteNotification(notificationId)

Delete Notification

Delete a notification.

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

Notification

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteNotificationV2

Success deleteNotificationV2(notificationId)

Delete NotificationV2

Delete a specific notification

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotification

Notification getNotification(notificationId)

Show notification

Get a notification by notification `not_` ID.

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

Notification

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotificationV2

NotificationV2 getNotificationV2(notificationId)

Get NotificationV2

Get a specific notification. Appears to require admin credentials by default. Expect a 403 Forbidden error response for normal users.

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

NotificationV2

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotificationV2s

List getNotificationV2s(limit)

List NotificationV2s

Retrieve all of the current user's notifications.

Parameters

Name	Type	Description	Notes
limit	Integer	The maximum number of entries to get.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getNotifications

List getNotifications(type, sent, hidden, after, n, offset)

List Notifications

Retrieve all of the current user's notifications.

Parameters

Name	Type	Description	Notes
type	String	Only send notifications of this type (can use `all` for all). This parameter no longer does anything, and is deprecated.	[optional] [default to null]
sent	Boolean	Return notifications sent by the user. Must be false or omitted.	[optional] [default to null]
hidden	Boolean	Whether to return hidden or non-hidden notifications. True only allowed on type `friendRequest`.	[optional] [default to null]
after	String	Only return notifications sent after this Date. Ignored if type is `friendRequest`.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

markNotificationAsRead

Notification markNotificationAsRead(notificationId)

Mark Notification As Read

Mark a notification as seen.

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]

Return type

Notification

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

replyNotificationV2

NotificationV2 replyNotificationV2(notificationId, body)

Reply NotificationV2

Reply to a specific notification

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]
body	Object

Return type

NotificationV2

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

respondNotificationV2

NotificationV2 respondNotificationV2(notificationId, RespondNotificationV2Request)

Respond NotificationV2

Respond to a specific notification

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]
RespondNotificationV2Request	RespondNotificationV2Request

Return type

NotificationV2

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json