POST/desk/api/v2/helpdocssites.json

Create a new helpdocssite.

Body Params

HelpdocsSite represents a help documents site.

    • Name
      articleTemplate
      Type
      string
    • Name
      authenticationType
      Type
      string
    • Name
      authenticationTypeId
      Type
      integer
    • Name
      categoryTemplate
      Type
      string
    • Name
      contactFormEnabled
      Type
      boolean
    • Name
      contributors
      Type
      array
      Description
      Relationships
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      customDomain
      Type
      string
    • Name
      customStyleSheet
      Type
      string
    • 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
      disqusShortname
      Type
      string
    • Name
      editMethod
      Type
      string
    • Name
      favicon
      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
      footerTemplate
      Type
      string
    • Name
      headTemplate
      Type
      string
    • Name
      headerBGColor
      Type
      string
    • Name
      helpdoctemplate
      Type
      object
    • Name
      homePageLinkEnabled
      Type
      boolean
    • Name
      homePageLinkText
      Type
      string
    • Name
      homePageURL
      Type
      string
    • Name
      homeTemplate
      Type
      string
    • Name
      htmlHeadCode
      Type
      string
    • Name
      id
      Type
      integer
    • Name
      languageCode
      Type
      string
    • Name
      linkColor
      Type
      string
    • Name
      logoImage
      Type
      string
    • Name
      metaSiteDescription
      Type
      string
    • Name
      name
      Type
      string
    • Name
      navActiveColor
      Type
      string
    • Name
      navTextColor
      Type
      string
    • Name
      pageBGColor
      Type
      string
    • Name
      password
      Type
      string
    • Name
      publicSiteEnabled
      Type
      boolean
    • Name
      searchTemplate
      Type
      string
      Description
      Templates
    • Name
      sendEmailsToInboxId
      Type
      integer
    • Name
      showDateLastModified
      Type
      boolean
    • Name
      showOnHomePage
      Type
      string
    • Name
      showSocialIcons
      Type
      boolean
    • 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
      stats
      Type
      object
    • Name
      subdomain
      Type
      string
    • Name
      textColor
      Type
      string
    • Name
      touchIcon
      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
      201
      Type
      object
      Schema
      Description
      201 Created
    • 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

    201 Created

    HelpdocsSiteAPIBody
    {
  "helpdocssite": {
    "articleTemplate": "string",
    "authenticationType": "string",
    "authenticationTypeId": 0,
    "categoryTemplate": "string",
    "contactFormEnabled": true,
    "contributors": [
      {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      }
    ],
    "createdAt": "2024-07-26T20:26:26.473Z",
    "createdBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "customDomain": "string",
    "customStyleSheet": "string",
    "deletedAt": "2024-07-26T20:26:26.473Z",
    "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-07-26T20:26:26.473Z",
    "updatedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    }
  },
  "included": {
    "helpdoctemplates": [
      {
        "code": "string",
        "createdAt": "2024-07-26T20:26:26.473Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-07-26T20:26:26.473Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "description": "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
        },
        "id": 0,
        "name": "string",
        "previewUrl": "string",
        "state": "string",
        "thumbnail": "string",
        "updatedAt": "2024-07-26T20:26:26.473Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      }
    ],
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2024-07-26T20:26:26.473Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-07-26T20:26:26.473Z",
        "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-07-26T20:26:26.473Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      }
    ]
  }
}
    Download Swagger