Skip to main content

Adding a new release using the Bitrise API

Release Management add-on

In this guide, we will be using the API to create a new release utilizing the Release Management add-on. Check out Release Management for more information.

You can add new iOS releases for your apps using the POST method of the releases/app-store endpoint. If you set the release candidate parameters (release_branch and workflow), then the latest successful build is automatically selected as a release candidate. If automatic_testflight_upload is also set to true, then an upload to TestFlight is started immediately.

The required parameters are:

  • app slug

  • bundle_id: The bundle ID of the app to be released

  • name: The name or version of the release. For example: 1.2.

Optional parameters are:

  • automatic_testflight_upload: Set this to true if you want to automatically upload every release candidate build to TestFlight.

  • description: An internal description of the release; it will not be included in the App Store review submission (metadata).

  • release_branch: The branch used to build the release candidate.

  • slack_webhook_url: The Slack webhook URL to send Slack notifications.

  • teams_webhook_url: The Teams webhook URL to send MS Teams notifications.

  • workflow: The Workflow used to build the release candidate.

Example 1. Creating a new release called "1.111" with automatic TestFlight upload enabled


curl -X 'POST' \
  '' \
  -H 'accept: application/json' \
  -H 'Authorization: 'THE-ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "automatic_testflight_upload": true,
  "bundle_id": "THE-BUNDLE-ID",
  "description": "",
  "name": "1.111",
  "release_branch": "main",
  "slack_webhook_url": "",
  "teams_webhook_url": "",
  "workflow": "deploy"