Edit

Share via

Update a package flight submission

  • Article

Use this method in the Microsoft Store submission API to update an existing package flight submission. After you successfully update a submission by using this method, you must commit the submission for ingestion and publishing.

For more information about how this method fits into the process of creating a package flight submission by using the Microsoft Store submission API, see Manage package flight submissions.

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 package flight submission for one of your apps. You can do this in Partner Center, or you can do this by using the create a package flight submission method.

Request

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

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

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 for which you want to update a package flight submission. For more information about the Store ID, see View app identity details.
flightId string Required. The ID of the package flight for which you want to update a submission. 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 to update. 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.
packageId string Required. The ID of the existing Package.

Request body

The request body has the following parameters.

Value Type Description
flightPackages array Contains objects that provide details about each package in the submission. For more details about the values in the response body, see Flight package resource. When calling this method to update an app submission, only the fileName, fileStatus, minimumDirectXVersion, and minimumSystemRam values of these objects are required in the request body. The other values are populated by Partner Center.
packageDeliveryOptions object Contains gradual package rollout and mandatory update settings for the submission. For more information, see Package delivery options object.
targetPublishMode string The publish mode for the submission. This can be one of the following values:
  • Immediate
  • Manual
  • SpecificDate
targetPublishDate string The publish date for the submission in ISO 8601 format, if the targetPublishMode is set to SpecificDate.
notesForCertification string Provides additional info for the certification testers, such as test account credentials and steps to access and verify features. For more information, see Notes for certification.

Request example

The following example demonstrates how to update a package flight submission for an app.

PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621243649 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "flightPackages": [
    {
      "id": "existingPackage.Id",
      "fileName": "newPackage.appx",
      "fileStatus": "PendingUpload",
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None"
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "targetPublishMode": "Immediate",
  "targetPublishDate": "",
  "notesForCertification": "No special steps are required for certification of this app."
}

Response

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

{
  "id": "1152921504621243649",
  "flightId": "cd2e368a-0da5-4026-9f34-0e7934bc6f23",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "flightPackages": [
    {
      "fileName": "newPackage.appx",
      "fileStatus": "PendingUpload",
      "id": "",
      "version": "1.0.0.0",
      "languages": ["en-us"],
      "capabilities": [],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None"
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/8b389577-5d5e-4cbe-a744-1ff2e97a9eb8?sv=2014-02-14&sr=b&sig=wgMCQPjPDkuuxNLkeG35rfHaMToebCxBNMPw7WABdXU%3D&se=2016-06-17T21:29:44Z&sp=rwl",
  "targetPublishMode": "Immediate",
  "targetPublishDate": "",
  "notesForCertification": "No special steps are required for certification of this app."
}

Error codes

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

Error code Description
400 The package flight submission could not be updated because the request is invalid.
409 The package flight submission could not be updated because of the current state of the app, or the app uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.