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

Update a helpdocssite.

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

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

    • Name
      helpdocssite
      Type
      object
      Description
      HelpdocsSite represents a help documents site.
    • 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
    • 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

    HelpdocsSiteAPIBody
    {  "helpdocssite": {    "articleTemplate": "string",    "authenticationType": "string",    "authenticationTypeId": 0,    "categoryTemplate": "string",    "contactFormEnabled": true,    "contributors": [      {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"        },        "type": 0      }    ],    "createdAt": "2026-09-28T13:04:32.784Z",
    Download Swagger