patch/guilds/{guild_id}/members/@me

Update current user guild member

Update current user guild member. User can modify their own nickname within the guild.

update_current_guild_member

Parameters

Name	In	Type	Description
guild_id*	path	SnowflakeType	The ID of the guild

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "nick": {
      "description": "The nickname to set for the member (1-32 characters)",
      "type": [
        "string",
        "null"
      ]
    },
    "avatar": {
      "description": "Base64-encoded image data for the member guild avatar",
      "anyOf": [
        {
          "$ref": "#/components/schemas/Base64ImageType"
        },
        {
          "type": "null"
        }
      ]
    },
    "banner": {
      "description": "Base64-encoded image data for the member guild banner",
      "anyOf": [
        {
          "$ref": "#/components/schemas/Base64ImageType"
        },
        {
          "type": "null"
        }
      ]
    },
    "bio": {
      "description": "The member guild profile bio (1-320 characters)",
      "type": [
        "string",
        "null"
      ]
    },
    "pronouns": {
      "description": "The member guild profile pronouns (1-40 characters)",
      "type": [
        "string",
        "null"
      ]
    },
    "accent_color": {
      "description": "The accent color for the member guild profile as an integer",
      "anyOf": [
        {
          "$ref": "#/components/schemas/ColorType"
        },
        {
          "type": "null"
        }
      ]
    },
    "profile_flags": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/GuildMemberProfileFlags",
          "description": "Bitfield of profile flags for the member"
        },
        {
          "type": "null"
        }
      ]
    },
    "mention_flags": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/MentionReplyPreferencesInput",
          "description": "Per-guild reply mention preference override for this member; NO_PREFERENCE inherits the user's account-wide setting"
        },
        {
          "type": "null"
        }
      ]
    },
    "mute": {
      "description": "Whether the member is muted in voice channels",
      "type": "boolean"
    },
    "deaf": {
      "description": "Whether the member is deafened in voice channels",
      "type": "boolean"
    },
    "communication_disabled_until": {
      "description": "ISO8601 timestamp until which the member is timed out",
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "timeout_reason": {
      "description": "The reason for timing out the member (1-512 characters)",
      "type": [
        "string",
        "null"
      ]
    },
    "channel_id": {
      "description": "The voice channel ID to move the member to",
      "anyOf": [
        {
          "$ref": "#/components/schemas/SnowflakeType"
        },
        {
          "type": "null"
        }
      ]
    },
    "connection_id": {
      "description": "The voice connection ID for the member",
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "user": {
      "description": "The user this guild member represents",
      "$ref": "#/components/schemas/UserPartialResponse"
    },
    "nick": {
      "description": "The nickname of the member in this guild",
      "type": [
        "string",
        "null"
      ]
    },
    "avatar": {
      "description": "The hash of the member guild-specific avatar",
      "type": [
        "string",
        "null"
      ]
    },
    "banner": {
      "description": "The hash of the member guild-specific banner",
      "type": [
        "string",
        "null"
      ]
    },
    "accent_color": {
      "description": "The accent colour of the member guild profile as an integer",
      "anyOf": [
        {
          "$ref": "#/components/schemas/Int32Type"
        },
        {
          "type": "null"
        }
      ]
    },
    "roles": {
      "maxItems": 250,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of role IDs the member has"
    },
    "joined_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "description": "ISO8601 timestamp of when the user joined the guild"
    },
    "mute": {
      "type": "boolean",
      "description": "Whether the member is muted in voice channels"
    },
    "deaf": {
      "type": "boolean",
      "description": "Whether the member is deafened in voice channels"
    },
    "communication_disabled_until": {
      "description": "ISO8601 timestamp until which the member is timed out",
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "profile_flags": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/GuildMemberProfileFlags"
        },
        {
          "type": "null"
        }
      ]
    },
    "mention_flags": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/MentionReplyPreferences",
          "description": "Per-guild reply mention preference override; NO_PREFERENCE means inherit the user-level mention_flags."
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "user",
    "roles",
    "joined_at",
    "mute",
    "deaf"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}