node-zendesk • Docs

---

node-zendesk / clients/helpcenter/articles / Article

Type Alias: Article

Article: object

Articles are content items such as help topics or tech notes contained in sections

Type declaration

author_id?

optional author_id: number

• The id of the user who wrote the article (set to the user who made the request on create by default)

body?

optional body: string

• HTML body of the article. Unsafe tags and attributes may be removed before display

comments_disabled?

optional comments_disabled: boolean

• True if comments are disabled; false otherwise

content_tag_ids?

optional content_tag_ids: any[]

• The list of content tags attached to the article

created_at?

optional created_at: string

• The time the article was created (read-only)

draft?

optional draft: boolean

• True if the translation for the current locale is a draft; false otherwise (read-only, can only be set when creating)

edited_at?

optional edited_at: string

• The time the article was last edited in its displayed locale (read-only)

html_url?

optional html_url: string

• The url of the article in Help Center (read-only)

id?

optional id: number

• Automatically assigned when the article is created (read-only)

label_names?

optional label_names: any[]

• An array of label names associated with this article

locale

locale: string

• The locale that the article is being displayed in (required)

outdated?

optional outdated: boolean

• Deprecated. Always false because the source translation is always the most up-to-date translation (read-only)

outdated_locales?

optional outdated_locales: any[]

• Locales in which the article was marked as outdated (read-only)

permission_group_id

permission_group_id: number

• The id of the permission group which defines who can edit and publish this article (required)

position?

optional position: number

• The position of this article in the article list. 0 by default

promoted?

optional promoted: boolean

• True if this article is promoted; false otherwise. false by default

section_id?

optional section_id: number

• The id of the section to which this article belongs

source_locale?

optional source_locale: string

• The source (default) locale of the article (read-only)

title

title: string

• The title of the article (required)

updated_at?

optional updated_at: string

• The time the article was last updated (read-only)

url?

optional url: string

• The API url of the article (read-only)

user_segment_id?

optional user_segment_id: number

• The id of the user segment which defines who can see this article

user_segment_ids?

optional user_segment_ids: any[]

• List of user segment ids which define who can view this article

vote_count?

optional vote_count: number

• The total number of upvotes and downvotes (read-only)

vote_sum?

optional vote_sum: number

• The sum of upvotes (+1) and downvotes (-1), which may be positive or negative (read-only)

Defined in

clients/helpcenter/articles.d.ts:4