Common ModelsArticles

The Article object

The Article object is used to represent a form of content in the knowledge base, such as an article or page.

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
titlestring or nullOptional<=254 characters
The title of the article.
descriptionstring or nullOptional<=2000 characters
Description of the article.
authorstring or nullOptionalformat: "uuid"
The user who created the article.
last_edited_bystring or nullOptionalformat: "uuid"
The user to last update the article.
visibilityenum or nullOptional

The visibility of the article.

  • PUBLIC - PUBLIC
  • INTERNAL - INTERNAL
  • RESTRICTED - RESTRICTED
Allowed values:
article_content_download_urlstring or nullOptional
The presigned S3 URL to fetch article content.
checksumstring or nullOptional<=254 characters
The SHA256 checksum of the article content.
article_urlstring or nullOptional<=2000 characters
The URL to the webpage of the article.
statusenum or nullOptional

The status of the article.

  • DRAFT - DRAFT
  • PUBLISHED - PUBLISHED
  • ARCHIVED - ARCHIVED
  • TRASH - TRASH
Allowed values:
typeenum or nullOptional

The type of the article.

  • PAGE - PAGE
  • BLOG_POST - BLOG_POST
  • SMART_LINK - SMART_LINK
Allowed values:
remote_created_atdatetime or nullOptional
When the third party's article was created.
remote_updated_atdatetime or nullOptional
When the third party's article was updated.
parent_articlestring or nullOptionalformat: "uuid"
The parent article an article is nested within.
parent_containerstring or nullOptionalformat: "uuid"
The parent container an article is nested within.
root_containerstring or nullOptionalformat: "uuid"
The top-level container in the hierarchy that holds this article. This will reference a container object that will typically be a SPACE or WORKSPACE type.
permissionslist of objectsOptional
attachmentslist of stringsOptional
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional
remote_datalist of objects or nullOptional