CommunityMessages
Update CommunityMessage
Update an existing CommunityMessage record.
PUT
Update CommunityMessage
Updates an existing CommunityMessage record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CommunityMessage-Edit role.Request Body
Required Fields
The Id of the CommunityMessage record to update.
ID of the conversation this message belongs to.
ID of the user account that posted this message.
Optional Fields
ID of the customer profile that posted this message.
Body text of the message.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the communitymessage was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update CommunityMessage