Skip to main content

Enable or disable an existing batch

PUT 

/platform/solutions/api/v1/orgs/{orgId}/batches/{batchId}/status

Enable or disable a batch by its ID.

Usage
PUT orgs/{orgId}/batches/{batchId}/status

Parameters

  • batchId (Guid, required): the ID of the batch.

Request body

  • input (UpdateBatchIsEnabledDto, required): specifies the IsEnabled status.

Responses

  • 200 OK: returns the updated BatchDto.
  • 400 Bad Request: invalid request (missing or invalid isEnabled).
  • 403 Forbidden: org not allowed.
  • 404 Not Found: batch not found.

Security
This API requires authentication.

Request

Responses

Returns the updated BatchDto