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

HelpdocArticleAPIBody handles the request/response for a single helpdoc article

    • Name
      helpdocarticle
      Type
      object
      Description
      HelpdocArticle represents a HelpdocArticle.
    • 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.

    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": "2025-06-25T10:32:51.704Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2025-06-25T10:32:51.704Z",    "deletedBy": {      "delete": true,
    Download Swagger