CSV 投稿

CSV または JSON スプレッドシートの行を 1 行につき 1 件の下書きドキュメントとして取り込みます。

CSV の行（または JSON スプレッドシートの行）を 下書き ドキュメントとして取り込み、1 行につき 1 件のドキュメントを作成します。

認証: Bearer JWT (WorkOS)。

クエリパラメーター

パラメーター	型	必須	備考
`website_id`	uuid	はい	対象となるウェブサイト。ほとんどのエンドポイントとは異なり、ここでは snake_case を使用します。

リクエスト本文

2 種類のコンテンツタイプが受け付けられ、Content-Type ヘッダーによって振り分けられます。

multipart/form-data — フィールド:

schema_name（テキスト、必須）
file（生の CSV バイト列、必須）。先頭行はヘッダーであり、各セルは前後の空白を取り除いた JSON 文字列値になります。

application/json（最大 10 MiB）:

{
  "schema_name": "post",
  "spreadsheet_data": [ { "title": "行 1" }, { "title": "行 2" } ]
}

schema_name（文字列、必須）
spreadsheet_data（オブジェクトの配列、必須）

レスポンス

{ "inserted": 2 }

201 Created を返します。各行は下書きドキュメントになり、ドキュメントのタイトルにはその行の最初の文字列値が使用されます。

例 — JSON

curl -X POST '{CMS_API_URL}/csv?website_id=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>' \
  -H 'Content-Type: application/json' \
  -d '{"schema_name":"post","spreadsheet_data":[{"title":"行 1"}]}'

例 — マルチパート CSV

curl -X POST '{CMS_API_URL}/csv?website_id=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>' \
  -F 'schema_name=post' \
  -F 'file=@data.csv'

エラー

400 — 解析エラー、schema_name/file の欠如、配列ではない spreadsheet_data、オブジェクトでない行、または空の CSV
401 — JWT の欠如または無効な JWT
500 — 挿入に失敗しました

Previous‹GET /usage NextPATCH /csv›

パラメーター

型

必須

備考

website_id

uuid

はい

対象となるウェブサイト。ほとんどのエンドポイントとは異なり、ここでは snake_case を使用します。

リクエスト本文

2 種類のコンテンツタイプが受け付けられ、Content-Type ヘッダーによって振り分けられます。

multipart/form-data — フィールド:

schema_name（テキスト、必須）

file（生の CSV バイト列、必須）。先頭行はヘッダーであり、各セルは前後の空白を取り除いた JSON 文字列値になります。

application/json（最大 10 MiB）:

{
  "schema_name": "post",
  "spreadsheet_data": [ { "title": "行 1" }, { "title": "行 2" } ]
}

schema_name（文字列、必須）

spreadsheet_data（オブジェクトの配列、必須）

curl -X POST '{CMS_API_URL}/csv?website_id=<uuid>' \ -H 'Authorization: Bearer <workos-jwt>' \ -H 'Content-Type: application/json' \ -d '{"schema_name":"post","spreadsheet_data":[{"title":"行 1"}]}'