#releaseBuild

Releases a build for distribution.

By default, apps cannot be released via the API. For security reasons, you can only release apps through the web UI with security token authentication. To enable API and CLI releases, go to Settings > General > Programmatic releases for the app and enable Allow releases without a security token.

See Automating releases from CI for the recommended async build and API release workflow.

#Request

POST /v1/releaseBuild
Authorization: Bearer <access-token>
Content-Type: application/json

#Headers

#JSON Body

{
  "email": "you@example.com",
  "appId": "your-app-id",
  "buildId": "your-build-id",
  "shouldSkipEmail": false
}

#Body Fields

#Authorization Rules

The bearer token must satisfy one of these paths:

• the account's legacy access token matches the supplied email, or
• an active personal access token belongs to that same user and has app access for the target app

The authenticated user must also have permission to release the target app.

#Response

{
  "message": "success"
}

#Example

curl \
  -X POST \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","appId":"your-app-id","buildId":"your-build-id"}' \
  "https://api.todesktop.com/v1/releaseBuild"

#Errors

• 400 if email, appId, or buildId is missing or not a string.
• 403 if the bearer token is missing, invalid, or the user does not have release permission for the app.
• 404 if the user for the supplied email cannot be found.
• 412 if the app requires a security-token-authenticated release, or if the build is not in a releasable state.