PATCH /api/v1/contents/{endpoint}/{content_id}/status
PATCH APIを用いることで、コンテンツの公開状態をAPI経由で変更することができます。
リクエストヘッダー
X-MICROCMS-API-KEY
PATCH APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「コンテンツの公開状態を変更」を有効にして、リクエストヘッダーに含めて送信してください。
Information
クライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かればAPIを呼び出せてしまうことにご注意ください。特に書き込み系のAPIキー(POST、PUT、PATCH、DELETE)の漏洩にご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。
Content-Type
送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/jsonと指定してください。
リクエストボディ
公開状態を変更するためには、PUBLISH
、またはDRAFT
を配列に文字列として渡してください。PUBLISH
はコンテンツを公開状態に変更できます。DRAFT
はコンテンツを下書き状態に変更できます。
{"status": ["PUBLISH"]}
公開終了にステータスを変更することはできません。statusに CLOSED
を渡すとエラーが返されます。
レスポンス
正常にコンテンツを作成できた場合は200
レスポンスが返却されます。