Vai al contenuto principale
PATCH
/
v1
/
batches
/
{batch_id}
Aggiorna i metadati del batch
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"
  }
}
Semantica di fusione: Gli aggiornamenti dei metadati seguono l’approccio di Stripe — le nuove chiavi vengono aggiunte, le chiavi esistenti vengono aggiornate e le chiavi impostate su stringa vuota "" vengono eliminate.

Autorizzazioni

​
Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer della forma Bearer , dove è il tuo token di autenticazione.

Parametri del percorso

​
batch_id
string
obbligatorio

L'ID del batch da aggiornare.

Corpo

application/json
​
metadata
object
obbligatorio

Insieme di coppie chiave-valore per memorizzare informazioni aggiuntive su un oggetto. Segue l'approccio di Stripe con regole di validazione: massimo 50 chiavi, chiave massimo 40 caratteri (senza parentesi quadre), valore massimo 500 caratteri, tutti i valori memorizzati come stringhe.

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

Risposta

Metadati del batch aggiornati con successo.

​
id
string

ID del Batch

​
object
string

Il tipo di oggetto. "batch" per questo endpoint.

​
status
string

in_progress o completed

​
created
number

Epoch creato

​
total_urls
number

Conteggio degli URL nel batch

​
completed_urls
number

Conteggio degli URL completati

​
metadata
object

Insieme di coppie chiave-valore per memorizzare informazioni aggiuntive su un oggetto. Segue l'approccio di Stripe con regole di validazione: massimo 50 chiavi, chiave massimo 40 caratteri (senza parentesi quadre), valore massimo 500 caratteri, tutti i valori memorizzati come stringhe.

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