PATCH /api/v1/contents/{endpoint}/{content_id}/status

最終更新日:2023年10月30日

PATCH APIを用いることで、コンテンツの公開状態をAPI経由で変更することができます。

Information

既知の不具合として、一部の条件で正常に動作しないケースを確認しております。詳細についてはヘルプをご参照ください。本件については、対応を検討しております。ご不便をおかけしますが、何卒ご理解賜りますようお願い申し上げます。

Information

リクエストヘッダー

PATCH APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「コンテンツの公開状態を変更」を有効にして、リクエストヘッダーに含めて送信してください。

Information: クライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かればAPIを呼び出せてしまうことにご注意ください。特に書き込み系のAPIキー(POST、PUT、PATCH、DELETE)の漏洩にご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。

送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/jsonと指定してください。

公開状態を変更するためには、PUBLISH、またはDRAFTを配列に文字列として渡してください。PUBLISHはコンテンツを公開状態に変更できます。DRAFTはコンテンツを下書き状態に変更できます。

// 「公開中」にする場合
{"status": ["PUBLISH"]}

//　「下書き中」にする場合
{"status": ["DRAFT"]}

Information

現在のところ、「公開中」と「下書き中」の相互の変更のみに対応しております。以下の様な操作には対応していないため、あらかじめご了承ください。

正常にコンテンツを作成できた場合は200レスポンスが返却されます。