PATCH/desk/api/v2/tickets/{ticketId}/reviewcomments/{id}.json

Update review comment

Path Params

  • Name
    ticketId
    Type
    integer
    required
    Description
  • Name
    id
    Type
    integer
    required
    Description

Body Params

ReviewCommentAPIBody handles the get/create/update request/response for reviewcomment.

    • Name
      included
      Type
      object
      Description
      Included allows adding referenced objects on the API response. The included keys should map to the `types` in the Relationship slices/objects.
    • Name
      reviewcomment
      Type
      object
      Description
      ReviewComment represents a ReviewComment.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      ReviewCommentAPIBody handles the get/create/update request/response for reviewcomment.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
    • Code
      404
      Type
      object
      Schema
      Description
      404 Not Found
      Error represents an occurrence of an error in the API.

    Examples

    200 OK

    ReviewCommentAPIBody
    {
      "included": {
        "users": [
          {
            "autoFollowOnCC": true,
            "avatarURL": "string",
            "createdAt": "2024-04-18T11:10:13.495Z",
            "createdBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "deletedAt": "2024-04-18T11:10:13.495Z",
            "deletedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "editMethod": "string",
            "email": "string",
            "filter_args": {
              "aggregate": {
                "Distinct": true,
                "Field": "string",
                "Operation": "string"
              },
              "bulkDryExecute": true,
              "fields": [
                "string"
              ],
              "filter": [
                "string"
              ],
              "id": 0,
              "ids": [
                0
              ],
              "includes": [
                "string"
              ],
              "orderBy": "string",
              "orderMode": "asc",
              "page": 0,
              "pageOffset": 0,
              "pageSize": 0,
              "skipAggregation": true
            },
            "firstName": "string",
            "id": 0,
            "isAppOwner": true,
            "isPartTime": true,
            "lastName": "string",
            "ldKey": "string",
            "onboarding": {
              "addedFirstInbox": true,
              "bookmarkPage": true,
              "checkDeskHelpSite": true,
              "checkSampleInbox": true,
              "dismissedWelcome": true,
              "exploreHelpsites": true,
              "exploreReports": true,
              "inviteTeam": true,
              "repliedToFirstTicket": true,
              "reviewedCompanySettings": true,
              "reviewedProfile": true
            },
            "projectsCompanyId": 0,
            "reviewer": true,
            "role": "string",
            "sendPushNotifications": true,
            "sendWebNotifications": true,
            "state": "string",
            "ticketReplyRedirect": "string",
            "timeFormatId": 0,
            "timezoneId": 0,
            "trainingWheelsEnrollment": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "updatedAt": "2024-04-18T11:10:13.495Z",
            "updatedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            }
          }
        ]
      },
      "reviewcomment": {
        "body": "string",
        "createdAt": "2024-04-18T11:10:13.495Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-04-18T11:10:13.495Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "filter_args": {
          "aggregate": {
            "Distinct": true,
            "Field": "string",
            "Operation": "string"
          },
          "bulkDryExecute": true,
          "fields": [
            "string"
          ],
          "filter": [
            "string"
          ],
          "id": 0,
          "ids": [
            0
          ],
          "includes": [
            "string"
          ],
          "orderBy": "string",
          "orderMode": "asc",
          "page": 0,
          "pageOffset": 0,
          "pageSize": 0,
          "skipAggregation": true
        },
        "id": 0,
        "message": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "state": "string",
        "status": "string",
        "ticket": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "updatedAt": "2024-04-18T11:10:13.495Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "user": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      }
    }