POST/desk/api/v2/helpdocscategories.json
Create a new helpdocscategory.
Body Params
HelpdocsCategory represents a HelpdocsCategory.
- 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
displayOnDocHomepage- Type
- boolean
- Name
displayOrder- Type
- integer
- Name
filter_args- Type
- object
- Description
- RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
- Name
helpDocsSites_id- Type
- integer
- Name
id- Type
- integer
- Name
name- Type
- string
- Name
oldURL- Type
- string
- Name
parent_id- 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
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
HelpdocsCategoryAPIBody handles the get/create/update request/response for helpdoccategory.
- 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.
201 Created
HelpdocsCategoryAPIBody
{
"helpdocscategory": {
"createdAt": "2024-07-26T20:26:26.553Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"deletedAt": "2024-07-26T20:26:26.553Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"displayOnDocHomepage": true,
"displayOrder": 0,
"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
},
"helpDocsSites_id": 0,
"id": 0,
"name": "string",
"oldURL": "string",
"parent_id": 0,
"slug": "string",
"state": "string",
"updatedAt": "2024-07-26T20:26:26.553Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
}
},
"included": {
"users": [
{
"autoFollowOnCC": true,
"avatarURL": "string",
"createdAt": "2024-07-26T20:26:26.553Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
},
"deletedAt": "2024-07-26T20:26:26.553Z",
"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.553Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {},
"type": 0
}
}
]
}
}