VRChatBackendDocs/Apis/InviteApi.md

InviteApi

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

Method	HTTP request	Description
getInviteMessage	GET /message/{userId}/{messageType}/{slot}	Get Invite Message
getInviteMessages	GET /message/{userId}/{messageType}	List Invite Messages
inviteMyselfTo	POST /invite/myself/to/{worldId}:{instanceId}	Invite Myself To Instance
inviteUser	POST /invite/{userId}	Invite User
inviteUserWithPhoto	POST /invite/{userId}/photo	Invite User with photo
requestInvite	POST /requestInvite/{userId}	Request Invite
requestInviteWithPhoto	POST /requestInvite/{userId}/photo	Request Invite with photo
resetInviteMessage	DELETE /message/{userId}/{messageType}/{slot}	Reset Invite Message
respondInvite	POST /invite/{notificationId}/response	Respond Invite
respondInviteWithPhoto	POST /invite/{notificationId}/response/photo	Respond Invite with photo
updateInviteMessage	PUT /message/{userId}/{messageType}/{slot}	Update Invite Message

getInviteMessage

InviteMessage getInviteMessage(userId, messageType, slot)

Get Invite Message

Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users!  Message type refers to a different collection of messages, used during different types of responses.  * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
messageType	String	The type of message to fetch, must be a valid InviteMessageType.	[default to message] [enum: message, request, requestResponse, response]
slot	Integer	The message slot to fetch of a given message type.	[default to null]

Return type

InviteMessage

Authorization

authCookie

HTTP request headers

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

getInviteMessages

List getInviteMessages(userId, messageType)

List Invite Messages

Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users!  Message type refers to a different collection of messages, used during different types of responses.  * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
messageType	String	The type of message to fetch, must be a valid InviteMessageType.	[default to message] [enum: message, request, requestResponse, response]

Return type

List

Authorization

authCookie

HTTP request headers

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

inviteMyselfTo

SentNotification inviteMyselfTo(worldId, instanceId)

Invite Myself To Instance

Sends self an invite to an instance

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]
instanceId	String	Must be a valid instance ID.	[default to null]

Return type

SentNotification

Authorization

authCookie

HTTP request headers

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

inviteUser

SentNotification inviteUser(userId, InviteRequest)

Invite User

Sends an invite to a user. Returns the Notification of type `invite` that was sent.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
InviteRequest	InviteRequest	Slot number of the Invite Message to use when inviting a user.

Return type

SentNotification

Authorization

authCookie

HTTP request headers

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

inviteUserWithPhoto

SentNotification inviteUserWithPhoto(userId, data, image)

Invite User with photo

Sends an photo invite to a user. Returns the Notification of type `invite` that was sent.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
data	InviteRequest		[default to null]
image	File	The binary blob of the png file.	[default to null]

Return type

SentNotification

Authorization

authCookie

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

requestInvite

Notification requestInvite(userId, RequestInviteRequest)

Request Invite

Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
RequestInviteRequest	RequestInviteRequest	Slot number of the Request Message to use when request an invite.	[optional]

Return type

Notification

Authorization

authCookie

HTTP request headers

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

requestInviteWithPhoto

Notification requestInviteWithPhoto(userId, data, image)

Request Invite with photo

Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
data	RequestInviteRequest		[default to null]
image	File	The binary blob of the png file.	[default to null]

Return type

Notification

Authorization

authCookie

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

resetInviteMessage

List resetInviteMessage(userId, messageType, slot)

Reset Invite Message

Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users!  Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\".  Message type refers to a different collection of messages, used during different types of responses.  * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite  The DELETE endpoint does not have/require any request body.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
messageType	String	The type of message to fetch, must be a valid InviteMessageType.	[default to message] [enum: message, request, requestResponse, response]
slot	Integer	The message slot to fetch of a given message type.	[default to null]

Return type

List

Authorization

authCookie

HTTP request headers

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

respondInvite

Notification respondInvite(notificationId, InviteResponse)

Respond Invite

Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification.  In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]
InviteResponse	InviteResponse	Slot number of the Response Message to use when responding to a user.

Return type

Notification

Authorization

authCookie

HTTP request headers

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

respondInviteWithPhoto

Notification respondInviteWithPhoto(notificationId, data, image)

Respond Invite with photo

Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification.  In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.'

Parameters

Name	Type	Description	Notes
notificationId	String	Must be a valid notification ID.	[default to null]
data	InviteResponse		[default to null]
image	File	The binary blob of the png file.	[default to null]

Return type

Notification

Authorization

authCookie

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

updateInviteMessage

List updateInviteMessage(userId, messageType, slot, UpdateInviteMessageRequest)

Update Invite Message

Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users!  Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\".  Message type refers to a different collection of messages, used during different types of responses.  * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
messageType	String	The type of message to fetch, must be a valid InviteMessageType.	[default to message] [enum: message, request, requestResponse, response]
slot	Integer	The message slot to fetch of a given message type.	[default to null]
UpdateInviteMessageRequest	UpdateInviteMessageRequest	Message of what to set the invite message to.	[optional]

Return type

List

Authorization

authCookie

HTTP request headers

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