Skip to content
GAMPEONCreate
New project

Mute or unmute a member in voice

PATCH
/v1/communities/{id}/voice/members/{handle}
curl --request PATCH \
--url https://api.gampeon.com/v1/communities/1/voice/members/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "muted": true }'

Needs muteMembers, and their highest role must be below yours. Applies to all voice channels of the community until someone lifts it. Muting turns their microphone off right away; after unmuting they turn it on themselves. In the audit log.

Not available with access tokens.

id
required
integer
>= 1

Community ID

handle
required
string
/^[a-z0-9_]{3,24}$/

Handle of the member

Media typeapplication/json
object
muted
required
boolean

Example generated

{
"muted": true
}

Muted state

Media typeapplication/json
object
muted
required
boolean

Example generated

{
"muted": true
}

Error codes: invalid_field

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: unauthorized

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: token_not_allowed, missing_permission, role_hierarchy, forbidden

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: not_found

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Report a problem with this pageOther ways to give feedback