Halt the rollout for an app submission

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

Note

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

Prerequisites

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

• If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
• Obtain an Azure AD access token to use in the request header for this method. After you obtain an access token, you have 60 minutes to use it before it expires. After the token expires, you can obtain a new one.
• Create a submission for one of your apps. You can do this in Partner Center, or you can do this by using the create an app submission method.
• Enable a gradual package rollout for the submission. You can do this in Partner Center, or you can do this by using the Microsoft Store submission API.

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}/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 submission with the package rollout you want to halt. For more information about the Store ID, see View app identity details.
submissionId	string	Required. The ID of the submission with the package rollout you want to halt. This ID is available in the response data for requests to create an app 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 an app submission.

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/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 submission could not be found.
409	This code indicates one of the following errors: The submission is not in a valid state for the gradual rollout operation (before calling this method, the submission must be published and the packageRolloutStatus value must be set to PackageRolloutInProgress). The submission does not belong to the specified app. The app uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.

Related topics

• Gradual package rollout
• Manage app submissions using the Microsoft Store submission API
• Create and manage submissions using Microsoft Store services