Rename an upload batch (`name: null` clears it). Optional `If-Match`; a stale tag returns 412 PRECONDITION_FAILED.
PATCH
/v1/upload-batches/{batchId}curl -X PATCH 'https://api.embodiflow.io/v1/upload-batches/{batchId}' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"name": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Path parameters
- batchIdstringrequired
Header parameters
- If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.
Request body
Content-Typeapplication/json
- namestring | nullrequired
Responses
Success
- dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- datasetIdstring | nullrequired
- sourceTypestringrequired
- statusstringrequired
- namestring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- lastActivityAtstringrequired
- totalSessionsnumber
- completedSessionsnumber
- failedSessionsnumber
- datasetCountnumber
- latestDatasetPlanStatusstring | null
- materializationStatusstring | null
- latestRunobject | nullrequired
- failureobjectrequired
- processingRefusedobject | null
Response example
{
"data": {
"id": "string",
"tenantId": "string",
"projectId": "string",
"datasetId": "string",
"sourceType": "string",
"status": "string",
"name": "string",
"createdAt": "string",
"updatedAt": "string",
"lastActivityAt": "string",
"totalSessions": 0,
"completedSessions": 0,
"failedSessions": 0,
"datasetCount": 0,
"latestDatasetPlanStatus": "string",
"materializationStatus": "string",
"latestRun": {
"id": "string",
"status": "string"
},
"failure": {
"code": "string",
"reason": "string",
"stepId": "string",
"stepName": "string",
"stepAlgorithm": {
"slug": "string",
"title": "string",
"official": false
},
"stepRunId": "string",
"runId": "string",
"stepErrorCode": "string"
},
"processingRefused": {
"code": "string"
}
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1