PATCH APIを用いることで、コンテンツの公開状態をAPI経由で変更することができます。
PATCH APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「コンテンツの公開状態を変更」を有効にして、リクエストヘッダーに含めて送信してください。
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー(APIの認証と権限管理)」をご覧ください。
送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/jsonと指定してください。
公開状態を変更するためには、PUBLISH、またはDRAFTを配列に文字列として渡してください。PUBLISHはコンテンツを公開状態に変更できます。DRAFTはコンテンツを下書き状態に変更できます。
// 「公開中」にする場合
{"status": ["PUBLISH"]}
// 「下書き中」にする場合
{"status": ["DRAFT"]}現在のところ、操作可能なステータス変更は限られています。詳細は以下の通りです。
■対応している変更
■対応していない変更
正常にコンテンツを作成できた場合は200レスポンスが返却されます。