Skip to main content

BanUserInput

No description

input BanUserInput {
userID: ID!
clientMutationId: String!
message: String!
siteIDs: [ID!]
rejectExistingComments: Boolean
rejectionReason: RejectCommentReasonInput
}

Fields

BanUserInput.userID ● ID! non-null scalar

userID is the ID of the User that should have their account banned.

BanUserInput.clientMutationId ● String! non-null scalar

clientMutationId is required for Relay support.

BanUserInput.message ● String! non-null scalar

message is sent to banned user via email.

BanUserInput.siteIDs ● [ID!] list scalar

site ID's to scope the ban to.

BanUserInput.rejectExistingComments ● Boolean scalar

whether or not to reject all the user's previous comments when banning them.

BanUserInput.rejectionReason ● RejectCommentReasonInput input

rejectionReason is the reason provided for why any existing comments are being rejected if DSA is enabled

Member Of

banUser mutation