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. If you want to enable releases via the API, contact support with your app ID.
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
400ifemail,appId, orbuildIdis missing or not a string.403if the bearer token is missing, invalid, the app is not enabled for API releases, or the user does not have release permission for the app.404if the user for the supplied email cannot be found.412if the build is not in a releasable state.