Builds
Update build
Update a build's notes. Only the fields provided are changed - a field sent as null is cleared, and fields left out are unchanged. PUT is also accepted, with the same behaviour. Builds still uploading or processing can't be changed (404). Requires builds:write scope.
PATCH
/applications/{application_id}/builds/{build_id}Authorization
bearerAuth AuthorizationBearer <token>
API key. Bearer authentication header of the form Bearer <token>, where <token> is your Workspace or Application API key.
In: header
Path Parameters
application_id*string
Application ID.
build_id*string
Build ID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.comapplications/aBc1234/builds/xYz9876" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d @- <<'EOF'{ "notes": "Fixes crash on launch."}EOF{ "message": "Build updated successfully.", "data": { "id": "xYz9876", "build_structure": "file", "version": "1.0.1", "version_short": "1.0.1", "version_semantic_major": 1, "version_semantic_minor": 0, "version_semantic_patch": 1, "version_semantic_extra": null, "version_semantic_meta": null, "build_number": "398", "platform": { "identifier": "windows", "name": "Windows", "short_name": "Windows", "upload_instruction": "Upload a .exe, .msi, or .zip installer." }, "stream": { "id": "stR4567", "name": "nightlies", "description": "Nightly development builds", "retention_days": 30, "created_at": "2025-06-10T09:15:00.000000Z", "updated_at": "2025-06-15T14:30:00.000000Z" }, "labels": [ { "id": "lbl1234", "name": "Production", "description": "Production-ready builds", "color": "#22c55e", "level": "application", "created_at": "2025-06-10T09:15:00.000000Z", "updated_at": "2025-06-15T14:30:00.000000Z" } ], "architectures": [ { "identifier": "x64", "name": "x64", "description": "64-bit x86 (AMD64 / Intel 64)" }, { "identifier": "arm64v8", "name": "ARM64v8", "description": "ARMv8-A 64-bit" } ], "notes": "Example build notes here.", "size_total_bytes": 52428800, "size_total_string": "50.00 MB", "metadata_total_bytes": 4096, "build_source": "ghactions", "ci_pipeline": { "ci_pipeline_name": "Nightly Build", "ci_pipeline_url": "https://github.com/buildstash/example/actions/workflows/nightly.yml", "ci_run_id": "12345678901", "ci_run_url": "https://github.com/buildstash/example/actions/runs/12345678901", "ci_build_duration": "00:05:00" }, "scm": { "scm_host_type": "git", "scm_host": "github", "scm_repo_name": "buildstash/example", "scm_repo_url": "https://github.com/buildstash/example", "scm_branch": "main", "scm_commit_sha": "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6", "scm_commit_sha_short": "1a2b3c4", "scm_commit_url": "https://github.com/buildstash/example/commit/1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6" }, "pending": false, "modal_url": "https://acme.buildstash.com/applications/aBc1234/builds/xYz9876", "download_url": "https://acme.buildstash.com/builds/xYz9876/download", "built_at": "2025-06-15T14:30:00.000000Z", "created_at": "2025-06-10T09:15:00.000000Z", "updated_at": "2025-06-15T14:30:00.000000Z", "upload_status": "complete", "upload_status_reason": null, "invalid_platform_build": false, "invalid_platform_build_reason": null }}{ "message": "Unauthorized"}{ "message": "This action requires 'resource:action' scope."}{ "message": "Not found."}{ "message": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }}