PATCH/desk/api/v2/helpdocssites/update.json
Update multiple helpdocssites.
Update all the given properties for matching resources. Any omitted properties will be unchanged.
The following values are allowed in the [filter](https://apidocs.teamwork.com/guides/desk/filtering-api-results) query parameter:
- articleTemplate
- authenticationType
- authenticationTypeId
- categoryTemplate
- contactFormEnabled
- createdAt
- createdBy
- customDomain
- customStyleSheet
- description
- disqusShortname
- editMethod
- favicon
- footerTemplate
- headTemplate
- headerBGColor
- homePageLinkEnabled
- homePageLinkText
- homePageURL
- homeTemplate
- htmlHeadCode
- id
- languageCode
- linkColor
- logoImage
- metaSiteDescription
- name
- navActiveColor
- navTextColor
- pageBGColor
- password
- publicSiteEnabled
- searchTemplate
- sendEmailsToInboxId
- showDateLastModified
- showOnHomePage
- showSocialIcons
- state
- subdomain
- textColor
- touchIcon
- updatedAt
- updatedBy
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
- 200
- Type
- object
- Schema
- Description
- 200 OK
BulkOpResponse is a bulk operation response
- 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.
200 OK
BulkOpResponse
{
"jobId": "string"
}