跳转到主要内容
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"
}