Mojang · JSON Structure

Minecraft Services Friend Update Request Structure

Body for PUT /friends.

Type: object Properties: 3 Required: 1
Games And ComicsMinecraftGamingIdentityPlayer ProfilesSessionPublic APIs

FriendUpdateRequest is a JSON Structure definition published by Mojang, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

profileName profileId updateType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mojang/refs/heads/main/json-structure/minecraft-services-friend-update-request-structure.json",
  "name": "FriendUpdateRequest",
  "description": "Body for PUT /friends.",
  "type": "object",
  "properties": {
    "profileName": {
      "type": "string",
      "description": "Friend's username (mutually exclusive with profileId).",
      "example": "Dinnerbone"
    },
    "profileId": {
      "type": "string",
      "description": "Friend's UUID (mutually exclusive with profileName).",
      "example": "853c80ef3c3749fdaa49938b674adae6"
    },
    "updateType": {
      "type": "string",
      "enum": [
        "ADD",
        "REMOVE"
      ],
      "example": "ADD"
    }
  },
  "required": [
    "updateType"
  ]
}