Add a Comment to a User

This API is used to add a User Comment to a User's account. User Comments are used to allow administrators and moderators the ability to take notes on Users.

Request#

Add a User Comment

POST/api/user/comment

OpenAPI Spec

Request Headers#

X-FusionAuth-TenantIdStringoptional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Request Body#

userComment.commentStringrequired

The text of the User Comment.

userComment.commenterIdUUIDrequired

The Id of the User that wrote the User Comment.

userComment.userIdUUIDrequired

The Id of the User that the User Comment was written for.

Example Request JSON

{
  "userComment": {
    "comment": "Not sure if this user is violating any rules or not.",
    "commenterId": "00000000-0000-0000-0000-000000000002",
    "userId": "00000000-0000-0000-0000-000000000003"
  }
}

Response#

The response for this API contain the User Comment that was added to the User's account.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

userComment.commentString

The text of the User Comment.

userComment.commenterIdUUID

The Id of the User that wrote the User Comment.

userComment.createInstantLongDEPRECATED

The instant when the comment was written. This was deprecated in 1.18.0. Use insertInstant instead.

userComment.insertInstantLong

The instant when the comment was written.

userComment.idUUIDImmutable

The Id of the User Comment.

userComment.userIdUUID

The Id of the User that the User Comment was written for.

Example Response JSON

{
  "userComment": {
    "comment": "Not sure if this user is violating any rules or not.",
    "commenterId": "00000000-0000-0000-0000-000000000002",
    "id": "00000000-0000-0000-0000-000000000042",
    "insertInstant": 1471786483322,
    "userId": "00000000-0000-0000-0000-000000000003"
  }
}