Halt the rollout for a flight

Use this method in the Microsoft Store submission API to halt the rollout for a package flight submission. For more information about the process of process of creating a package flight submission by using the Microsoft Store submission API, see Manage package flight submissions.

Note

If you halt the rollout for a package flight submission and then create a new package flight submission, the new submission is a clone of the halted submission.

Prerequisites

To use this method, you need to first do the following:

Request

This method has the following syntax. See the following sections for usage examples and descriptions of the header and request parameters.

Method Request URI
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}/haltpackagerollout

Request header

Header Type Description
Authorization string Required. The Azure AD access token in the form Bearer <token>.

Request parameters

Name Type Description
applicationId string Required. The Store ID of the app that contains the package flight submission with the package rollout you want to halt. For more information about the Store ID, see View app identity details.
flightId string Required. The ID of the package flight that contains the submission with the package rollout you want to halt. This ID is available in the response data for requests to create a package flight and get package flights for an app. For a flight that was created in Partner Center, this ID is also available in the URL for the flight page in Partner Center.
submissionId string Required. The ID of the submission with the package rollout to halt. This ID is available in the response data for requests to create a package flight submission. For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

Request body

Do not provide a request body for this method.

Request example

The following example demonstrates how to halt the package rollout for a package flight submission.

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621243680/haltpackagerollout HTTP/1.1
Authorization: Bearer <your access token>

Response

The following example demonstrates the JSON response body for a successful call to this method. For more details about the values in the response body, see Package rollout resource.

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 0.0,
    "packageRolloutStatus": "PackageRolloutStopped",
    "fallbackSubmissionId": "1212922684621243058"
}

Error codes

If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Error code Description
404 The package flight submission could not be found.
409 This code indicates one of the following errors: