Salesforce Knowledge Article

Schema for a Salesforce Knowledge article record.

ArticlesCRMCustomer ServiceDocumentationKnowledge ManagementSupport

Properties

Name Type Description
Id string Salesforce record ID for the KnowledgeArticle
KnowledgeArticleId string The master article ID shared across all versions
Title string Title of the knowledge article
UrlName string URL-friendly slug used in article URLs
Summary string Short summary of the article content
PublishStatus string Current publication status of the article
Language string Language code for the article (e.g., en_US, fr, de)
VersionNumber integer Version number of the article
IsVisibleInApp boolean Whether the article is visible in the Salesforce app channel
IsVisibleInPkb boolean Whether the article is visible in the Public Knowledge Base channel
IsVisibleInCsp boolean Whether the article is visible in the Customer Portal channel
IsVisibleInPrm boolean Whether the article is visible in the Partner Portal channel
LastPublishedDate string Timestamp when the article was last published
CreatedDate string Timestamp when the article was created
LastModifiedDate string Timestamp when the article was last modified
CreatedById string Salesforce ID of the user who created the article
OwnerId string Salesforce ID of the article owner
View JSON Schema on GitHub

JSON Schema

salesforce-knowledge-management-article-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/salesforce-knowledge-management/blob/main/json-schema/salesforce-knowledge-management-article-schema.json",
  "title": "Salesforce Knowledge Article",
  "description": "Schema for a Salesforce Knowledge article record.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "Salesforce record ID for the KnowledgeArticle"
    },
    "KnowledgeArticleId": {
      "type": "string",
      "description": "The master article ID shared across all versions"
    },
    "Title": {
      "type": "string",
      "description": "Title of the knowledge article"
    },
    "UrlName": {
      "type": "string",
      "description": "URL-friendly slug used in article URLs",
      "pattern": "^[a-z0-9-]+$"
    },
    "Summary": {
      "type": "string",
      "description": "Short summary of the article content"
    },
    "PublishStatus": {
      "type": "string",
      "description": "Current publication status of the article",
      "enum": ["Online", "Draft", "Archived"]
    },
    "Language": {
      "type": "string",
      "description": "Language code for the article (e.g., en_US, fr, de)",
      "examples": ["en_US", "fr", "de", "es", "ja"]
    },
    "VersionNumber": {
      "type": "integer",
      "description": "Version number of the article",
      "minimum": 1
    },
    "IsVisibleInApp": {
      "type": "boolean",
      "description": "Whether the article is visible in the Salesforce app channel"
    },
    "IsVisibleInPkb": {
      "type": "boolean",
      "description": "Whether the article is visible in the Public Knowledge Base channel"
    },
    "IsVisibleInCsp": {
      "type": "boolean",
      "description": "Whether the article is visible in the Customer Portal channel"
    },
    "IsVisibleInPrm": {
      "type": "boolean",
      "description": "Whether the article is visible in the Partner Portal channel"
    },
    "LastPublishedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the article was last published"
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the article was created"
    },
    "LastModifiedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the article was last modified"
    },
    "CreatedById": {
      "type": "string",
      "description": "Salesforce ID of the user who created the article"
    },
    "OwnerId": {
      "type": "string",
      "description": "Salesforce ID of the article owner"
    }
  },
  "required": ["Title", "PublishStatus"]
}