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-09-06T11:47:13.090Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2024-09-06T11:47:13.090Z",    "deletedBy": {      "delete": true,
    Download Swagger