vrchatapi-rust/docs/InviteApi.md

\InviteApi

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

Method	HTTP request	Description
get_invite_message	GET /message/{userId}/{messageType}/{slot}	Get Invite Message
get_invite_messages	GET /message/{userId}/{messageType}	List Invite Messages
invite_myself_to	POST /invite/myself/to/{worldId}:{instanceId}	Invite Myself To Instance
invite_user	POST /invite/{userId}	Invite User
request_invite	POST /requestInvite/{userId}	Request Invite
reset_invite_message	DELETE /message/{userId}/{messageType}/{slot}	Reset Invite Message
respond_invite	POST /invite/{notificationId}/response	Respond Invite
update_invite_message	PUT /message/{userId}/{messageType}/{slot}	Update Invite Message

get_invite_message

crate::models::InviteMessage get_invite_message(user_id, message_type, 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	Required	Notes
user_id	String	Must be a valid user ID.	[required]
message_type	InviteMessageType	The type of message to fetch, must be a valid InviteMessageType.	[required]
slot	i32	The message slot to fetch of a given message type.	[required]

Return type

crate::models::InviteMessage

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_invite_messages

Veccrate::models::InviteMessage get_invite_messages(user_id, message_type) 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	Required	Notes
user_id	String	Must be a valid user ID.	[required]
message_type	InviteMessageType	The type of message to fetch, must be a valid InviteMessageType.	[required]

Return type

Veccrate::models::InviteMessage

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invite_myself_to

crate::models::SentNotification invite_myself_to(world_id, instance_id) Invite Myself To Instance

Sends self an invite to an instance

Parameters

Name	Type	Description	Required	Notes
world_id	String	Must be a valid world ID.	[required]
instance_id	String	Must be a valid instance ID.	[required]

Return type

crate::models::SentNotification

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invite_user

crate::models::SentNotification invite_user(user_id, invite_request) Invite User

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

Parameters

Name	Type	Description	Required	Notes
user_id	String	Must be a valid user ID.	[required]
invite_request	InviteRequest	Slot number of the Invite Message to use when inviting a user.	[required]

Return type

crate::models::SentNotification

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

request_invite

crate::models::Notification request_invite(user_id, request_invite_request) Request Invite

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

Parameters

Name	Type	Description	Required	Notes
user_id	String	Must be a valid user ID.	[required]
request_invite_request	Option<RequestInviteRequest>	Slot number of the Request Message to use when request an invite.

Return type

crate::models::Notification

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_invite_message

Veccrate::models::InviteMessage reset_invite_message(user_id, message_type, 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	Required	Notes
user_id	String	Must be a valid user ID.	[required]
message_type	InviteMessageType	The type of message to fetch, must be a valid InviteMessageType.	[required]
slot	i32	The message slot to fetch of a given message type.	[required]

Return type

Veccrate::models::InviteMessage

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

respond_invite

crate::models::Notification respond_invite(notification_id, invite_response) Respond Invite

Respond to an invite request by sending a world invite to the requesting user. :notificationId is the ID of the requesting notification.

Parameters

Name	Type	Description	Required	Notes
notification_id	String	Must be a valid notification ID.	[required]
invite_response	InviteResponse	Slot number of the Response Message to use when responding to a user.	[required]

Return type

crate::models::Notification

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_invite_message

Veccrate::models::InviteMessage update_invite_message(user_id, message_type, slot, update_invite_message_request) 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	Required	Notes
user_id	String	Must be a valid user ID.	[required]
message_type	InviteMessageType	The type of message to fetch, must be a valid InviteMessageType.	[required]
slot	i32	The message slot to fetch of a given message type.	[required]
update_invite_message_request	Option<UpdateInviteMessageRequest>	Message of what to set the invite message to.

Return type

Veccrate::models::InviteMessage

Authorization

authCookie

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]