tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > PublishingService > unpublish

PublishingService.unpublish() method

Unpublishes items according to the specified instructions. This operation returns an instance of ‘PublishTransactionsCreationResult’ type.

Signature:

static unpublish({ requestModel, }: {
        requestModel: UnPublishRequest;
    }): CancelablePromise<PublishTransactionsCreationResult>;

Parameters

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

Returns:

CancelablePromise<PublishTransactionsCreationResult>

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

Exceptions

ApiError