tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > BatchOperationsService > batchUnpublish

BatchOperationsService.batchUnpublish() method

Unpublishes a batch of items. This operation returns an instance of ‘BatchOperationCreationResult’ type.

Signature:

static batchUnpublish({ requestModel, }: {
        requestModel: BatchUnPublishRequest;
    }): CancelablePromise<BatchOperationCreationResult>;

Parameters

Parameter	Type	Description
{ requestModel, }	{ requestModel: BatchUnPublishRequest; }

Returns:

CancelablePromise<BatchOperationCreationResult>

BatchOperationCreationResult The request has been accepted for processing, but the processing has not been completed.

Exceptions

ApiError