Saltar al contenido principal
PATCH
/
v1
/
batches
/
{batch_id}
Batch-Metadaten aktualisieren
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"
  }
}
Semántica de fusión: Las actualizaciones de metadatos siguen el enfoque de Stripe: se añaden nuevas claves, se actualizan las claves existentes y las claves establecidas en una cadena vacía "" se eliminan.

Autorizaciones

​
Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

​
batch_id
string
requerido

Die ID des Batches, der aktualisiert werden soll.

Cuerpo

application/json
​
metadata
object
requerido

Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen (keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte als Zeichenfolgen gespeichert.

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

Respuesta

Batch-Metadaten erfolgreich aktualisiert.

​
id
string

Batch-ID

​
object
string

Die Art des Objekts. "batch" für diesen Endpunkt.

​
status
string

in_progress oder completed

​
created
number

Erstelltes Epochendatum

​
total_urls
number

Anzahl der URLs im Batch

​
completed_urls
number

Anzahl der abgeschlossenen URLs

​
metadata
object

Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen (keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte als Zeichenfolgen gespeichert.

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