Passer au contenu principal
PATCH
/
v1
/
batches
/
{batch_id}
Mettre à jour les métadonnées du lot
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"
  }
}
Sémantique de fusion : Les mises à jour des métadonnées suivent l’approche de Stripe — les nouvelles clés sont ajoutées, les clés existantes sont mises à jour, et les clés définies sur une chaîne vide "" sont supprimées.

Autorisations

​
Authorization
string
header
requis

En-tête d'authentification Bearer sous la forme Bearer , où est ton jeton d'authentification.

Paramètres de chemin

​
batch_id
string
requis

L'ID du lot à mettre à jour.

Corps

application/json
​
metadata
object
requis

Ensemble de paires clé-valeur pour stocker des informations supplémentaires sur un objet. Suit l'approche de Stripe avec des règles de validation : max 50 clés, clé max 40 caractères (pas de crochets), valeur max 500 caractères, toutes les valeurs stockées en tant que chaînes.

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

Réponse

Métadonnées du lot mises à jour avec succès.

​
id
string

ID du lot

​
object
string

Le type d'objet. "batch" pour ce point de terminaison.

​
status
string

in_progress ou completed

​
created
number

Époque créée

​
total_urls
number

Nombre d'URLs dans le lot

​
completed_urls
number

Nombre d'URLs complétées

​
metadata
object

Ensemble de paires clé-valeur pour stocker des informations supplémentaires sur un objet. Suit l'approche de Stripe avec des règles de validation : max 50 clés, clé max 40 caractères (pas de crochets), valeur max 500 caractères, toutes les valeurs stockées en tant que chaînes.

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