update_article
Modifies Zendesk Guide articles by updating title, body, locale, draft status, permissions, user segments, and labels via a structured API call using the article ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | Updated article body content (HTML) | |
| draft | No | Whether the article is a draft | |
| id | Yes | Article ID to update | |
| label_names | No | Updated labels | |
| locale | No | Updated article locale (e.g., 'en-us') | |
| permission_group_id | No | Updated permission group ID | |
| title | No | Updated article title | |
| user_segment_id | No | Updated user segment ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"body": {
"description": "Updated article body content (HTML)",
"type": "string"
},
"draft": {
"description": "Whether the article is a draft",
"type": "boolean"
},
"id": {
"description": "Article ID to update",
"type": "number"
},
"label_names": {
"description": "Updated labels",
"items": {
"type": "string"
},
"type": "array"
},
"locale": {
"description": "Updated article locale (e.g., 'en-us')",
"type": "string"
},
"permission_group_id": {
"description": "Updated permission group ID",
"type": "number"
},
"title": {
"description": "Updated article title",
"type": "string"
},
"user_segment_id": {
"description": "Updated user segment ID",
"type": "number"
}
},
"required": [
"id"
],
"type": "object"
}