Edit Article
Edit_ArticleUpdate fields on an existing article.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | ||
| tags | No | ||
| title | No | ||
| status | No | ||
| content | No | Article body. Markdown by default; pass HTML with content_format="html" or "auto" to have it converted to Markdown on the way in. | |
| excerpt | No | ||
| site_id | Yes | ||
| keywords | No | ||
| language | No | ||
| og_image | No | Absolute URL for Open Graph image. | |
| og_title | No | ||
| author_id | No | Author ID. Pass empty string to clear the byline. | |
| is_pinned | No | ||
| article_id | Yes | ||
| help_order | No | Sort order of this article within its help collection (lower shows first). | |
| meta_title | No | ||
| schema_type | No | ||
| article_type | No | ||
| content_kind | No | Switch the article between "blog" and "help" (help-center / KB). | |
| canonical_url | No | ||
| collection_id | No | ID of the help-center collection (section) this article belongs to. Pass empty string to remove it from its section. | |
| focus_keyword | No | ||
| scheduled_for | No | ISO 8601 UTC time to auto-publish, e.g. "2026-06-01T15:00:00Z". Requires status="scheduled"; pass null to clear. Scheduling is hourly only: any minutes are rounded UP to the next whole hour (10:30 becomes 11:00). The response includes the effective time; relay that to the user. | |
| twitter_image | No | Absolute URL for Twitter card image. | |
| twitter_title | No | ||
| content_format | No | Format of content. "markdown" (default) stores it as-is; "html" converts imported HTML to Markdown; "auto" converts only if the content looks like HTML. Kamaan stores article bodies as Markdown. | |
| og_description | No | ||
| meta_description | No | ||
| primary_category | No | ||
| content_pillar_id | No | ||
| featured_image_alt | No | ||
| featured_image_url | No | ||
| twitter_description | No |