POST
/api/v1/server/suspensions
Request
Response
201
Created
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Body
issuedBystringrequiredMember ID of the staff member suspending them.
memberIdstringrequiredMember ID of the member being suspended.
reasonstringrequiredReason, 4-1024 characters.
endAtinteger | nullWhen it ends, at least a day away. Leave it out for no end date.
pointsnumberPoints, from 0 to 1000. Defaults to 0.
Response
201 Created
expiredbooleanrequiredWhether it has expired.
idstringrequiredUnique ID.
memberIdstringrequiredMember ID of the suspended member.
pointsintegerrequiredPoints it carries.
reasonstringrequiredWhy they were suspended.
serverIdstringrequiredServer ID.
startedAtintegerrequiredWhen it started.
startedBystringrequiredMember ID of who suspended them.
voidedbooleanrequiredWhether it has been voided.
dmDisabledbooleanrequiredWhether the member turned off infraction DMs.
endAtinteger | nullWhen it's scheduled to end. Missing for indefinite suspensions.
endedAtinteger | nullWhen it ended early.
endedBystring | nullMember ID of who ended it early.
endedReasonstring | nullWhy it ended early.
expiredAtinteger | nullWhen it expired.
voidReasonstring | nullWhy it was voided.
voidedBystring | nullMember ID of who voided it.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
403 | Success |
409 | The member is already suspended |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |
502 | next did not confirm the write. Check whether it applied before retrying. |
503 | Write endpoints are not configured on this deployment |