v6 documentation is incomplete, want to contribute?

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.

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

DELETE
/message/{userId}/{messageType}/{slot}
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

messageTypestring

The type of message to fetch, must be a valid InviteMessageType.

Default"message"
Value in"message" | "response" | "request" | "requestResponse"
slotinteger

The message slot to fetch of a given message type.

Range0 <= value <= 11

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.vrchat.cloud/api/1/message/string/message/11"
[
  {
    "canBeUpdated": true,
    "id": "invm_24a1c14d-5e24-48e5-90e3-c3f712420ffa",
    "message": "string",
    "messageType": "message",
    "remainingCooldownMinutes": 0,
    "slot": 11,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

{
  "error": {
    "message": "Really? A negative slot? Tsk-tsk․․․",
    "status_code": 400
  }
}

{
  "error": {
    "message": "You are not authorized to perform that action.",
    "status_code": 401
  }
}

{
  "error": {
    "message": "There's no entry for that slot.",
    "status_code": 404
  }
}

{
  "error": {
    "message": "Please wait 60 more minutes until you try again․",
    "status_code": 429
  }
}