Activate/Suspend Single Batch

Activate or suspend a batch.

Method

PUT /batch/{id}/suspended

Parameters

Path Parameters

Name Description
id The id of the batch to activate or suspend.

Request Body

A JSON object with the following properties:

Name Description
suspended A Boolean value which indicates whether to activate or suspend the batch. When the value is set to true, the batch will be suspended and when the value is set to false, the batch will be activated.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Returned if the batch cannot be suspended or activated. See the Introduction for the error response format.

Example

Request

PUT /batch/aBatch/suspended

{
  "suspended" : true,
}

Response

Status 204. No content.

On this Page: