Update Comment
Author:
Kirill Gaiduk
Changed on:
9 Dec 2024
Overview
The `updateComment`
Prerequisites
Specific Permissions are required for updating Comments:
`COMMENT_UPDATE``COMMENT_VIEW`
Key points
- Use the Mutation to update an existing Comment
`updateComment` - Manage the Comment Permissions at the Account or Retailer level
- Apply the "Retailer-specific Comment Permission Check" validation logic with the Setting (
`fc.graphql.comment.access`value)`retailer`
Inputs
The Input fields for updating a Comment are defined with the `UpdateCommentInput`
Field | Type | Description | Notes |
| ID! | Id of the Comment | |
| String! | Comment text | Max character limit: 200 |
Validation
Comment Permissions could be managed at the Account or Retailer level, which is controlled via the `fc.graphql.comment.access`
The
`retailer``updateComment`- A target Comment is found by its Id (input)
- A Comment Entity field stores a Retailer of the associated Entity
`retailerId` - The Comment is compared to the querying User
`retailerId`(defined with the User Role Context Id)`retailerId` - The Comment is updated upon the mentioned (User and Comment) 's match
`retailerId`
Response
The response consists of the details of the Comment:
Field | Type | Description | Notes |
| ID! | Id of the Comment | |
| String! | Type of the Entity | For example:
|
| ID | Id of the Entity | |
| String | Reference of the Entity | |
| String! | Comment text | |
| DateTime | Time of the Comment creation | |
| DateTime | Time of the Comment last update | |
| User | The author of the Comment |
|
Sample Payload
1mutation updateComment ($input: UpdateCommentInput) {
2 updateComment (input: $input) {
3 id
4 entityType
5 entityRef
6 entityId
7 text
8 createdOn
9 updatedOn
10 }
11}Language: graphqlschema
Name: Sample updateComment Mutation
Description:
Updating the Comment.
API Endpoint:
`POST: {{fluentApiHost}}/graphql`1{
2 "input": {
3 "id": "26963",
4 "text": "Sample Comment"
5 }
6}Language: graphqlschema
Name: Sample GraphQL Variables for the updateComment Mutation
Description:
Updating the Comment with a specified Id.
1{
2 "data": {
3 "updateComment": {
4 "id": "26963",
5 "entityType": "ORDER",
6 "entityRef": null,
7 "entityId": "123",
8 "text": "Sample Comment",
9 "createdOn": "2024-12-09T09:15:57.396Z",
10 "updatedOn": "2024-12-09T09:22:57.791Z"
11 }
12 }
13}Language: graphqlschema
Name: updateComment Mutation Response Example
Description:
Updating the Comment with a specified Id.
