Notiondesk API を使用してヘルプセンターの設定を更新します

REST API を介して Notiondesk ヘルプセンターの設定を更新します: SEO インデックス、ページタイトル、llms.txt およびマークダウンのエクスポート、お問い合わせフォーム、および変更履歴。

2 分で読めます

Notiondesk API を使用すると、検索エンジンのインデックス登録、各言語のページタイトルと説明、AI 最適化、お問い合わせフォーム、変更履歴など、ヘルプセンターの設定をコードから変更できます。この API を使用すると、同じ設定を複数のヘルプセンターに適用したり、設定をバージョン管理したりすることができます。

方法パス範囲変更点
PATCH/sites/{site_id}/settings/contentwrite検索エンジンのインデックス登録、言語ごとのページタイトルと説明
PATCH/sites/{site_id}/settings/ai-optimizationwritellms.txt、マークダウンエクスポート、およびAIコンテキストメニュー
PATCH/sites/{site_id}/settings/contact-formwriteお問い合わせフォームが表示されるかどうか
PATCH/sites/{site_id}/settings/changelogwrite変更履歴とそのオプション

言語と自動翻訳については、専用の記事「Notiondesk API を使用して言語と自動翻訳を管理する」を参照してください。色、フォント、レイアウトについては、「__ ND_TERM_5bcd8dee__ API を使用してヘルプセンターのブランディングとテーマをカスタマイズする」を参照してください。

設定の更新の仕組み

このページに掲載されているすべてのルートは、同じルールに従います。

  • 変更した項目のみを送信してください。送信しなかった項目は、現在の値を保持します。
  • JSONブール値を送信します。__ PRESERVED_71__またはfalseのみ: 値0および"false"はtrueとして読み取られます。
  • 不明なフィールドは400 validation_errorで拒否され、何も変更されません。

検索エンジンのインデックス登録、ページタイトルと説明

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/content" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"seo_indexing_enabled": true, "items": [{"locale": "fr", "page_title": "Centre d aide Example", "page_description": "Toutes les réponses sur Example"}]}'
分野タイプ注記読み返し
seo_indexing_enabledブール値検索エンジンがヘルプセンターをインデックスできるかどうかseo_indexing_enabled
itemsオブジェクトのリスト変更するオブジェクトは言語ごとに1つです。setting_content_items

items内の各オブジェクト：

分野タイプ注記
locale弦必須。ヘルプセンターが対応している言語。リストには最大1回のみ指定可能。
page_title文字列またはnull最大255文字。nullでクリアします。
page_description文字列またはnull最大255文字。nullでクリアします。

オブジェクトは、それが持つフィールドのみを変更します。また、items から除外した言語は、タイトルと説明を保持します。items は、言語を追加または削除することはできません。

ある言語のエラーでは、フィールドパスにその名前が付けられます。たとえば、items[fr].page_title のようになります。

seo_indexing_enabled: false 検索エンジンにヘルプセンター全体のインデックス登録を停止するよう要求します。詳しくは「検索エンジンによるヘルプセンターのクロールとインデックス登録を防止する」をご覧ください。

AI最適化

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/ai-optimization" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"llms_txt_enabled": true, "markdown_export_enabled": true, "ai_contextual_menu_enabled": true}'
分野タイプ読み返し
llms_txt_enabledブール値: ヘルプセンターがllms.txtを公開するかどうかllms_txt_enabled
markdown_export_enabledブール値: 記事をマークダウン形式で読み込めるかどうかmarkdown_export_enabled
ai_contextual_menu_enabledブール値: 記事にAIコンテキストメニューを表示するかどうかai_contextual_menu_enabled

計画にはAI最適化を含める必要があります。各機能の動作については、ヘルプセンターの「AI最適化の設定」および「GEO/AI最適化の概要」を参照してください。

お問い合わせフォーム

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/contact-form" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'
分野タイプ読み返し
enabledブール値: ヘルプセンターに問い合わせフォームを表示するかどうかcontact_form_enabled
  • APIはフォームのオン/オフを切り替えるだけで、それ以上の機能はありません。送信を受信するアドレスはダッシュボードで設定します。destination_emailsを含む本文は400 validation_errorに応答し、何も変更しません。
  • フォームは、住所が登録されている場合にのみ有効になります。住所が登録されていないヘルプセンターに対してフォームを有効にすると、400 validation_error が destination_emails に対して返されます。まずダッシュボードで住所を設定してください。フォームを無効にする場合は、住所は不要です。
  • プランには、フォームを非表示にする機能も含め、高度なカスタマイズ機能が含まれている必要があります。

変更履歴

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/changelog" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "reactions_enabled": true, "changelog_categories": [{"category_id": "2984612035", "color": "blue_sky"}]}'
分野タイプ注記読み返し
enabledブール値変更履歴が公開されるかどうかchangelog_enabled
email_subscriptions_enabledブール値読者が変更履歴メールを購読できるかどうか。true は変更履歴メール通知を含むプランが必要です。changelog_email_subscriptions_enabled
reactions_enabledブール値読者が変更履歴のエントリに反応できるかどうかchangelog_reactions_enabled
email_subject_pattern弦変更履歴メールの件名。最大255文字。削除できません。nullと""は変更されません。changelog_email_subject_pattern
changelog_categoriesオブジェクトのリスト変更履歴コレクションの全セットchangelog_categories

changelog_categories の各オブジェクトには、必須の category_id、コレクションの id、および最大 255 文字のオプションの color があります。

changelog_categories セット全体を置き換えます。除外したコレクションは変更履歴コレクションではなくなり、すべて削除されます。1つだけ追加したい場合は、最初に読み込んでください。セットには最大100個のコレクションを保持できます。[]changelog_categoriesGET /sites/{site_id}

プランには変更履歴を含める必要があります。メール購読が有効になっているにもかかわらず、プランに変更履歴のメール通知が含まれなくなった場合、"email_subscriptions_enabled": false が送信されるまで、このルートへのすべてのリクエストに対して 403 permission_denied が返されます。

詳細については、「ヘルプセンターでの変更履歴の設定」および「変更履歴のメール購読を有効にする方法」を参照してください。

エラー

状態いつcode
400値が無効または長すぎる、言語またはコレクションが不明または重複している、変更ログコレクションが100を超える、destination_emailsが送信された、連絡先フォームが住所なしで表示されたままになる、または本文に不明なフィールドがあるvalidation_error
403キーにはwriteスコープがありませんinsufficient_scope
403ご利用のプランには、機能（AI最適化、高度なカスタマイズ、変更履歴、または変更履歴のメール通知）が含まれていません。または、キーの作成者はこのヘルプセンターを変更できません。permission_denied
404ヘルプセンターはワークスペースに存在しませんnot_found

エラーエンベロープおよびその他のコードについては、 「Notiondesk API エラー、レート制限、および再試行の処理」を参照してください。

よくある質問

設定変更を確認するにはどうすればよいですか？

GET /sites/{site_id} をお読みください。各フィールドの上の「読み戻し値」列には、新しい値が表示される場所が示されています。

APIを使って問い合わせフォームのメールアドレスを変更できますか？

いいえ。ダッシュボードで設定してください。APIはフォームの表示/非表示を切り替えるだけです。

APIを使ってMCP検索を有効にできますか？

いいえ。ダッシュボードで MCP 検索を有効にしてください。API では、その状態が mcp_search_enabled で表示されます。MCP検索を有効にする を参照してください。

APIを使ってヘルプセンターのアクセスモードを変更できますか？

いいえ。公開、パスワード、ゲストアカウントのアクセス権限はダッシュボードで設定します。APIは現在のモードをaccess_modeで表示します。

次は？

関連する記事

このページは役に立ちましたか？

Still need help? Ask us