PATCH/desk/api/v2/helpdocssites/{siteId}/helpdocarticles/{id}.json

Update a helpdocarticle.

Update all the given properties for this resource. Any omitted properties will be unchanged.

Path Params

  • Name
    siteId
    Type
    integer
    required
    Description
  • Name
    id
    Type
    integer
    required
    Description

Body Params

HelpdocArticle represents a HelpdocArticle.

    • Name
      categories
      Type
      array
      Description
      Non-database fields
    • Name
      contents
      Type
      string
      Description
      Virtual fields
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      description
      Type
      string
    • Name
      displayOrder
      Type
      integer
    • Name
      disqusEnabled
      Type
      boolean
    • Name
      editMethod
      Type
      string
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      helpdocsite
      Type
      object
    • Name
      id
      Type
      integer
    • Name
      isPrivate
      Type
      boolean
    • Name
      oldURL
      Type
      string
    • Name
      popularity
      Type
      integer
    • Name
      relatedArticles
      Type
      array
    • Name
      siteId
      Type
      integer
    • Name
      slug
      Type
      string
    • Name
      state
      Type
      string
      Description
      State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
    • Name
      status
      Type
      string
    • Name
      title
      Type
      string
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      HelpdocArticleAPIBody handles the request/response for a single helpdoc article
    • 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.

    Examples

    200 OK

    HelpdocArticleAPIBody
    {
      "helpdocarticle": {
        "categories": [
          0
        ],
        "contents": "string",
        "createdAt": "2024-04-24T00:52:20.158Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-04-24T00:52:20.158Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "description": "string",
        "displayOrder": 0,
        "disqusEnabled": true,
        "editMethod": "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
        },
        "helpdocsite": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "id": 0,
        "isPrivate": true,
        "oldURL": "string",
        "popularity": 0,
        "relatedArticles": [
          0
        ],
        "siteId": 0,
        "slug": "string",
        "state": "string",
        "status": "string",
        "title": "string",
        "updatedAt": "2024-04-24T00:52:20.158Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      },
      "included": {
        "sites": [
          {
            "articleTemplate": "string",
            "authenticationType": "string",
            "authenticationTypeId": 0,
            "categoryTemplate": "string",
            "contactFormEnabled": true,
            "contributors": [
              {
                "delete": true,
                "id": 0,
                "meta": {},
                "type": 0
              }
            ],
            "createdAt": "2024-04-24T00:52:20.158Z",
            "createdBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "customDomain": "string",
            "customStyleSheet": "string",
            "deletedAt": "2024-04-24T00:52:20.158Z",
            "deletedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "description": "string",
            "disqusShortname": "string",
            "editMethod": "string",
            "favicon": "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
            },
            "footerTemplate": "string",
            "headTemplate": "string",
            "headerBGColor": "string",
            "helpdoctemplate": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "homePageLinkEnabled": true,
            "homePageLinkText": "string",
            "homePageURL": "string",
            "homeTemplate": "string",
            "htmlHeadCode": "string",
            "id": 0,
            "languageCode": "string",
            "linkColor": "string",
            "logoImage": "string",
            "metaSiteDescription": "string",
            "name": "string",
            "navActiveColor": "string",
            "navTextColor": "string",
            "pageBGColor": "string",
            "password": "string",
            "publicSiteEnabled": true,
            "searchTemplate": "string",
            "sendEmailsToInboxId": 0,
            "showDateLastModified": true,
            "showOnHomePage": "string",
            "showSocialIcons": true,
            "state": "string",
            "stats": {
              "articleCount": 0,
              "draftCount": 0,
              "publishedCount": 0,
              "unpublishedCount": 0
            },
            "subdomain": "string",
            "textColor": "string",
            "touchIcon": "string",
            "updatedAt": "2024-04-24T00:52:20.158Z",
            "updatedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            }
          }
        ],
        "users": [
          {
            "autoFollowOnCC": true,
            "avatarURL": "string",
            "createdAt": "2024-04-24T00:52:20.158Z",
            "createdBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            },
            "deletedAt": "2024-04-24T00:52:20.158Z",
            "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-24T00:52:20.158Z",
            "updatedBy": {
              "delete": true,
              "id": 0,
              "meta": {},
              "type": 0
            }
          }
        ]
      }
    }