microCMS

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

最終更新日: 2020/09/04

PATCH APIを用いることで、コンテンツの編集をAPI経由で行うことができます。
プランによってPATCH APIのリクエスト上限数は異なります。

リクエストヘッダー

X-WRITE-API-KEY

POST, PUT, PATCH, DELETE APIリクエストの際に必要な認証キーです。
リクエストヘッダーに含めて送信してください。
未使用の場合は削除しておくことを推奨します。

Information

API-KEY / WRITE-API-KEYはサービス内の全API共通となります。
そのため、クライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かれば他のAPIも呼び出せてしまうことにご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。

Content-Type

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

リクエストボディ

APIスキーマに沿って送信したい内容のJSONを用意し、文字列として渡してください。
例:

{"title":"bodyサンプル","publishedAt":"2020-04-23T14:32:38.163Z"}

各フィールドにおける値の指定方法は下記の通りです。

テキストフィールド

任意の文字列を指定してください。
(例:"テキスト1")

テキストエリア、リッチエディタ

改行コードを用いることで複数行の文字列を指定できます。
(例:"複数行のテキストを入力\n複数行のテキストを入力")

画像、ファイル

非対応です。指定しても空になります。

日時

ISO 形式 (ISO 8601) の文字列で指定してください。
(例:"2020-04-23T14:32:38.163Z")

数字

数字を指定してください。
(例:123)

真偽値

真偽値を指定してください。
(例:true)

コンテンツ参照

参照先コンテンツの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レスポンスが返却されます。