Update views batch job

PATCH

https://api.hi.umnai.com/views-batch-jobs/:viewsBatchJobId

PATCH

/views-batch-jobs/:viewsBatchJobId

curl -X PATCH https://api.hi.umnai.com/views-batch-jobs/viewsBatchJobId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Sample Views Batch Job"
}'

{
  "id": "483be50d0ddd306d15dd0cd4896e7715",
  "name": "Sample Views Batch Job",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "views_batch_configuration": {
    "id": "9c3ff42a41d026dee0d885357a576747",
    "name": "Sample Views Batch Configuration"
  },
  "status": "STARTING",
  "created_at": "2026-03-15T10:15:30.000000Z",
  "model": {
    "id": "20f35e630daf44dbfa4c3f68f5399d8c",
    "name": "Sample Model"
  },
  "workspace": {
    "id": "1629dee48cc4e53161f9b2be8614e062",
    "name": "Sample Workspace"
  },
  "compute_configuration": {
    "id": "351df95006b1350e597762a1d58e9319",
    "name": "Sample Compute Configuration"
  },
  "maximum_runtime_seconds": 1,
  "stage": "sample_stage",
  "progress": 0.5,
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z",
  "views_batches": [
    {
      "id": "52eab2b319178fc157009bfae5b9c3ca",
      "name": "Sample Views Batche"
    }
  ]
}

Update an existing views batch job.

Authentication

AuthorizationBearer

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

Path parameters

viewsBatchJobIdstringRequired

Unique ID of the views batch job.

Request

Views batch job details to update.

namestringOptional3-50 characters

Updated name of the views batch job.

Response

Views batch job successfully updated.

idstring

Unique ID of the batch job.

namestring3-50 characters

Name of the batch job.

accountobject

views_batch_configurationobject

statusenum

created_atdatetime

Timestamp when the batch job was created.

modelobject

workspaceobjectOptional

compute_configurationobjectOptional

maximum_runtime_secondsintegerOptional>=1

Specifies the maximum allowed runtime, in seconds, for the training job.

stagestringOptional

The current stage of the job.

progressfloatOptional

The overall progress of the job.

created_byobject or nullOptional

Reference of the user who created the batch job, if known.

updated_atdatetimeOptional

Timestamp when the batch job was last updated.

views_batcheslist of objectsOptional

List of views batches associated with the views batch job.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error