PATCH APIを用いることで、コンテンツの編集をAPI経由で行うことができます。
PATCH APIリクエストの際に必要な認証キーです。
デフォルト権限もしくは個別権限で「PATCH」を有効にして、リクエストヘッダーに含めて送信してください。
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー（APIの認証と権限管理）」をご覧ください。
送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/jsonと指定してください。
下書きのコンテンツを更新・追加するためのパラメータです。status=draftをパラメータとして追加してください。
更新時の挙動は「リクエスト成功時の各ステータスごとの挙動」をご参照ください。
APIスキーマに沿って送信したい内容のJSONを用意し、文字列として渡してください。
例：
{"title":"サンプルタイトル","category": ["サンプルカテゴリ"]}任意の文字列を指定してください。
（例："テキスト1"）
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
HTML文字列を用いることで装飾や画像を指定できます。詳しくはリッチエディタのWRITE APIをご覧ください。
（例："<h1>見出し</h1><p>このようにHTMLで入稿できます</p>"）
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
HTMLタグを付与した状態での登録は非対応となります。
※HTMLを登録した場合、以下のようにエスケープされます。<p>テキスト1</p> → ＆lt;p＆gt;テキスト1＆lt;/p＆gt;
microCMSの同じサービスにアップロードされた画像のURLを指定してください。
（例："https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample.png" ）
メディアのカスタムドメインが設定されている場合、カスタムドメインとデフォルトのドメイン（microcms-assets.io）の両方を受け付けられます。
また、以下のように不正なURLを指定した場合はエラーになります。
microCMSの同じサービスにアップロードされた画像のURLを配列で指定してください。
（例：["https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample1.png", "https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample2.png"]）
指定可能な画像URLについては、画像フィールドと同様です。
ISO 形式 (ISO 8601) の文字列で指定してください。
（例："2020-04-23T14:32:38.163Z"）
数字を指定してください。
（例：123）
真偽値を指定してください。
（例：true）
セレクトフィールドの要素を配列で指定してください。
（例：["要素1","要素2"]）
参照先コンテンツのcontentIdを指定してください。
（例："参照先id"）
参照先コンテンツのcontentIdを配列で指定してください。
（例：["参照先id1","参照先id2"]）
更新したいフィールドの内容をオブジェクト形式で指定してください。fieldIdと更新したいフィールドの値1つ以上を含めてください。
（例：{ "fieldId": "YOURFIELDID", "some_value": "" }）
対象となるデータをカスタムフィールドの配列で指定してください。配列の各要素には、fieldIdとすべてのフィールドの値を含めてください。
例：
[
{
"fieldId": "YOURFIRSTFIELDID",
"sometext_value": ""
},
{
"fieldId": "YOUR_SECOND_FIELD_ID",
"some_int_value": 10
}
]実装例はヘルプサイト「PATCH APIで繰り返しフィールド内の特定のフィールドの値を更新する際はどのように指定すればいいですか？」をご確認ください。
microCMSの同じサービスにアップロードされたメディアのURLを指定してください。
（例："https://files.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/manual.pdf" ）
メディアのカスタムドメインが設定されている場合、カスタムドメインとデフォルトのドメイン（microcms-assets.io）の両方を受け付けられます。
また、以下のように不正なURLを指定した場合はエラーになります。
対象となるデータ（message部分）をオブジェクト形式で指定してください。更新したいプロパティのみを指定して更新できます。
各値の詳細については、拡張フィールドをご確認ください。
例：
{
"id": "some-id",
"title": "some-title",
"description": "some-description",
"imageUrl": "https://images.microcms-assets.io/assets/xxxx/yyyy/{fileName}.png",
"updatedAt": "2024-01-01T00:00:00Z",
"data": { "id": "123" }
}ISO 形式 (ISO 8601) の文字列で指定してください。
（例："2024-01-01T00:00:00Z"）
PATCH APIにおいてフィールドの値を空値で登録したい場合、フィールドの種類に応じて以下の値を指定し、リクエストしてください。
フィールドの種類 | 空値で登録する場合に指定する値 |
|---|---|
テキストフィールド |
|
テキストエリア |
|
リッチエディタ |
|
旧リッチエディタ（非推奨） |
|
画像 |
|
複数画像 |
|
日時 |
|
真偽値 |
|
セレクトフィールド |
|
コンテンツ参照 |
|
複数コンテンツ参照 |
|
数字 |
|
カスタムフィールド |
|
繰り返しフィールド |
|
ファイル |
|
拡張フィールド |
|
コンテンツを更新する際は、すべてのフィールドを指定する必要はありません。更新したいフィールドだけを指定してください。
PATCH APIのリクエストに成功した際、コンテンツの各ステータスにおける挙動は以下のようになります。
コンテンツのステータス | 更新後の挙動 |
|---|---|
公開中 | 公開中のステータスのまま、コンテンツが更新されます。 |
公開中かつ下書き中 | 公開中のステータスのコンテンツが更新されます。 下書き中のステータスのコンテンツは変わりません。 |
下書き中 | 下書き中のステータスのまま、コンテンツが更新されます。 |
公開終了 | 更新されません。 |
status=draftを指定してリクエストした際の挙動は以下になります。
コンテンツのステータス | 更新後の挙動 |
|---|---|
公開中 | ステータスが「公開中かつ下書き中」になります。 公開中のコンテンツは維持されたまま、更新内容が下書き中のコンテンツとして保存されます。 |
公開中かつ下書き中 | ステータスは「公開中かつ下書き中」のままです。 下書き中のコンテンツのみが更新され、公開中のコンテンツは維持されます。 |
下書き中 | ステータスは「下書き中」のままです。 下書き中のコンテンツが更新されます。 |
公開終了 | 更新されません。 |
コンテンツAPIのエラーレスポンスを参照ください。