Jump to content

Community

REST API Documentation

/core/members/{id}/warnings


Store a new warning for the member

The warning will be issued as the current authorized user if using an OAuth access token, otherwise the 'moderator' parameter must be specified to indicate which moderator the warning should be issued from


Parameters

Name Type Description
Required moderator nt|null object Member ID of the moderator to issue the warning from
reason nt|null object Warn reason to use for this warning
points nt|null object Points to issue for the warning. Will use the points from the reason if not specified and a reason is, or if the reason does not allow points to be overridden.
memberNote tring|null object Note to display to the member as HTML (e.g. "<p>This is a comment.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type.
moderatorNote tring|null object Note to display to moderators as HTML (e.g. "<p>This is a comment.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type.
acknowledged bool Whether the warning should be considered acknowledged by the member or not
modQueue atetime|int|null object Date to place in moderator queue until or -1 to place in moderator queue indefinitely. NULL to not place member in moderator queue.
restrictPosts atetime|int|null object Date to restrict posts until or -1 to restrict posts indefinitely. NULL to not restrict posts.
suspend atetime|int|null object Date to suspend member until or -1 to suspend indefinitely. NULL to not suspend.
expire atetime|int|null object Date to expire warn points after or -1 to not expire warn points. Will use the warn points expiration from the warn reason if not specified and a reason is, or if the reason does not allow warn point removal to be overridden. NULL to not expire.

Exceptions

Code Message Description
2C292/G NO_PERMISSION The authorized user does not have permission to warn the member
2C292/O INVALID_ID The member could not be found
1C292/Y MODERATOR_REQUIRED When not using an OAuth access token a moderator member ID must be supplied

Response

Name Type Description
id int ID number
member member object Member who was warned
moderator member object Moderator who performed the warning
points int The points issued for the warning
reason reason object Warn reason if one was specified
expiration atetime|int object Date the warning expires, or -1 if the warning does not expire
date datetime Date the warning was issued
acknowledged bool Whether or not the warning has been acknowledged
memberNotes string Warn notes left for the member
moderatorNotes string Warn notes visible to moderators
modQueuePermanent bool Member is permanently moderator queued
modQueue tring|null object DateTimeInterval (from date) when the member will be removed from the moderator queue or null
restrictPostsPermanent bool Member is permanently on post restriction
restrictPosts tring|null object DateTimeInterval (from date) when the member will be removed from post restriction or null
suspendPermanent bool Member is permanently on suspension
suspend tring|null object DateTimeInterval (from date) when the member will be unsuspended or null

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl tring|null object URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value

reason object

Name Type Description
id int ID number
name string Warn reason name
defaultNotes string Default notes for warning (moderator can override)
points int The warning points levied with the warning
pointsOverride bool Whether the moderator can override the default points or not
removeOverride bool Whether the moderator can override when the points will be removed or not
removePoints tring|null object Time frame as a date interval when points will automatically be removed, or null if points do not automatically remove
pointsAutoRemove bool Whether points are automatically removed or not
×
×
  • Create New...