PATCH /api/v1/{endpoint}/{content_id}
PATCH APIを用いることで、コンテンツの編集をAPI経由で行うことができます。
リクエストヘッダー
X-MICROCMS-API-KEY
PATCH APIリクエストの際に必要な認証キーです。
デフォルト権限もしくは個別権限で「PATCH」を有効にして、リクエストヘッダーに含めて送信してください。
Informationクライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かればAPIを呼び出せてしまうことにご注意ください。特に書き込み系のAPIキー(POST、PUT、PATCH、DELETE)の漏洩にご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。
Content-Type
送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/jsonと指定してください。
リクエストボディ
APIスキーマに沿って送信したい内容のJSONを用意し、文字列として渡してください。
例：
{"title":"サンプルタイトル","category": ["サンプルカテゴリ"]}各フィールドにおける値の指定方法は下記の通りです。
テキストフィールド
任意の文字列を指定してください。
（例："テキスト1"）
テキストエリア
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
リッチエディタ
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
HTMLタグを付与した状態での登録は非対応となります。
※HTMLを登録した場合、以下のようにエスケープされます。<p>テキスト1</p> → ＆lt;p＆gt;テキスト1＆lt;/p＆gt;
画像、ファイル
非対応です。指定しても空になります。
日時
ISO 形式 (ISO 8601) の文字列で指定してください。
（例："2020-04-23T14:32:38.163Z"）
数字
数字を指定してください。
（例：123）
真偽値
真偽値を指定してください。
（例：true）
セレクトフィールド
セレクトフィールドの要素を配列で指定してください。
（例：["要素1","要素2"]）
コンテンツ参照
参照先コンテンツのcontentIdを指定してください。
（例："参照先id"）
コンテンツ複数参照
参照先コンテンツのcontentIdを配列で指定してください。
（例：["参照先id1","参照先id2"]）
カスタムフィールド
対象フィールド内容をオブジェクト形式で指定してください。
（例：{ "fieldId": "YOUR_FIELD_ID", "some_value": "" }）
繰り返しフィールド
対象となるデータ内容をカスタムフィールドのリスト形式で指定してください。
（例：[ { "fieldId": "YOUR_FIRST_FIELD_ID", "some_text_value": "" }, { "fieldId": "YOUR_SECOND_FIELD_ID", "some_int_value": 10 } ]）
拡張フィールド
対象となるデータ内容（message部分）をオブジェクト形式で指定してください。詳しい仕様はドキュメントをご確認ください。
（例：{ "id": "some-id", "title": "some-title", "description": "some-description", "imageUrl": "some-image-url", "updatedAt": "some-updated-at", "data": { "id": "123" } }）
レスポンス
正常にコンテンツを作成できた場合は200レスポンスが返却されます。