メインコンテンツへスキップ
PATCH
/
v1
/
batches
/
{batch_id}
バッチメタデータを更新
curl --request PATCH \
  --url https://api.olostep.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "status": "reviewed",
    "reviewer": "jane@example.com"
  }
}
'
{
  "id": "batch_abc123def456",
  "object": "batch",
  "status": "completed",
  "created": 1704067200,
  "total_urls": 10,
  "completed_urls": 10,
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "status": "reviewed",
    "reviewer": "jane@example.com"
  }
}
マージのセマンティクス: メタデータの更新はStripeのアプローチに従います。新しいキーは追加され、既存のキーは更新され、空の文字列 "" に設定されたキーは削除されます。

承認

Authorization
string
header
必須

Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。

パスパラメータ

batch_id
string
必須

更新するバッチのID。

ボディ

application/json
metadata
object
必須

オブジェクトに関する追加情報を保存するためのキーと値のペアのセット。Stripeのアプローチに従い、検証ルールがあります:最大50キー、キーは最大40文字(角括弧なし)、値は最大500文字、すべての値は文字列として保存されます。

:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}

レスポンス

バッチメタデータが正常に更新されました。

id
string

バッチID

object
string

オブジェクトの種類。このエンドポイントでは"batch"だよ。

status
string

in_progress または completed

created
number

作成されたエポック

total_urls
number

バッチ内のURLの数

completed_urls
number

完了したURLの数

metadata
object

オブジェクトに関する追加情報を保存するためのキーと値のペアのセット。Stripeのアプローチに従い、検証ルールがあります:最大50キー、キーは最大40文字(角括弧なし)、値は最大500文字、すべての値は文字列として保存されます。

:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}