Product Fruits · Schema
Import Articles Request
Request body for importing or updating knowledge base articles
Product AdoptionUser OnboardingIn-App GuidanceChecklistsNPS SurveysAnnouncementsUser SegmentationSaaS
Properties
| Name | Type | Description |
|---|---|---|
| articles | array | Array of articles to import (maximum 50 per request) |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.productfruits.com/schemas/import-articles-request",
"title": "Import Articles Request",
"description": "Request body for importing or updating knowledge base articles",
"type": "object",
"required": ["articles"],
"properties": {
"articles": {
"type": "array",
"maxItems": 50,
"description": "Array of articles to import (maximum 50 per request)",
"items": {
"type": "object",
"required": ["correlationId", "contents"],
"properties": {
"correlationId": {
"type": "string",
"description": "External ID for the article used for idempotent upserts"
},
"categoryCorrelationId": {
"type": "string",
"description": "Correlation ID of the parent category"
},
"isPrivate": {
"type": "boolean",
"description": "Whether the article is private"
},
"contents": {
"type": "array",
"maxItems": 20,
"description": "Multilingual content for the article (maximum 20 languages)",
"items": {
"type": "object",
"required": ["lang", "title", "content"],
"properties": {
"lang": {
"type": "string",
"description": "Language code (e.g., en, fr, de)"
},
"title": {
"type": "string",
"description": "Article title"
},
"content": {
"type": "string",
"description": "Article body content"
},
"format": {
"type": "string",
"enum": ["markdown"],
"description": "Content format"
},
"publishStatus": {
"type": "string",
"enum": ["published", "unpublished"],
"description": "Publication status of the article content"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}