Skip to main content
Version: 0.37.88

RESTPatchAPIGuildMemberJSONBody

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Index

Properties

optionalchannel_id

channel_id?: null | string

ID of channel to move user to (if they are connected to voice)

Requires MOVE_MEMBERS permission

optionalcommunication_disabled_until

communication_disabled_until?: null | string

Timestamp of when the time out will be removed; until then, they cannot interact with the guild

optionaldeaf

deaf?: null | boolean

Whether the user is deafened in voice channels. Will throw a 400 if the user is not in a voice channel

Requires DEAFEN_MEMBERS permission

optionalmute

mute?: null | boolean

Whether the user is muted in voice channels. Will throw a 400 if the user is not in a voice channel

Requires MUTE_MEMBERS permission

optionalnick

nick?: null | string

Value to set users nickname to

Requires MANAGE_NICKNAMES permission

optionalroles

roles?: null | string[]

Array of role ids the member is assigned

Requires MANAGE_ROLES permission