---
id: release-update
title: "Update a release"
description: "Update information for a release."
sidebar_label: "Update a release"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/isEP7WA/JbY2aZvbtahGfYhSJyuWBIEZ/FssZVIlaTseIb++3CkZMsvWdJibxj6xZaoE+/uuXuOp1tzgTYxsnBSKx7zm0KAQybVTJscaJHNtGHADGYIFrs84haT0ki34vHtmk8RDJpx6VIe395X9xHXBRr/5oXgMa/fi0u/MY+4g7nl8S2/Cg/4fcQLMJCjQ2P9lpIMKcClPOIKcuQxl4L0JinmwOM1d6vCryqHczS8irjBz6U0KHjsTInRnleTFNnFj0zPmEux7Qo+Ql5kyOPByemQjKd90Lo3WqxIUaKVQ+XoEooik4l3rPfR0rbrQ4v09CMmjke8MASDk2i9nANX2pacdUaqOT9mZ5A9ZqsqcwIOEicXhGSBSjS7FAYTcEgwzUBm/qJU1sE08xBvHN2+7qTzC7WKh9rIKuJgLbpjXm1Rvg0hmZYyExd05UUjXpqMRzxHBwIc+ODuICHFkfgdg6FU8nPpo0b5R1B4q/aDVm1t+NJ9a4T968yl0gYNbIqZVnPLnN5RNhydVbWbz8ZxzMIDJgUqJ2crut74wOjlnb250MknNB2ZwxwpAgTjC7TcXP3CXAqOZZqib5k2rDB6IQVaBkmCltx4Aj2eOlfYuNerV7qJzntezPaGozMyYxPH520xU+kMmBUj+doI8hqEkCQDGfNkenT7Aa2qbS6GzGuvNNm5NNIhr6rKk90WWtmQUSf9Pv0dRnpTh9gSLLOlh2NWZgTCV/P6gAEW84VPtS0VaiJF7a0fvHBwL+KJQSLrA9BNqIz+5uvoMmZ2ZR3mnaUUx4hzrN599/0P1cb4F2TaAo0lKOuElmjYTGeZXlKMrzEH5WTC3gcpWnt1jfl7NK8p6gt6RyvbveM7CTjo9ruDjkkGrWpUm/TFvD4gtGbTjeviCJO/1eRvNflbTX55Td6pWkd0h4aRcAOHHSdzPBpremAd5AVbpqi8TgqHW/kqXavYxeSkf3LaGfQ7/cFkcBKfDuPR2W8trvi+stqpo/898w5PtPosG374cHh8nWcSlWNojDZsc9oxUSKljlQLyKRgUhWlo/TKpbUU120f/ZedcaEAnWtBcHl7fCmxlkhxUEla0s8z/91kctlU1kQLqquFQUtw18y0BSZyJhOWtPF4hd15N2LDfp9+BvRzSj/D17u1od+nnN215UnW5pCkUmHHIAiqz7Uub5dnM3F5ro38HW2wDc2CDkGQWWn2KscUxEP9IUGJGWB7gRFTI3EWsbTMQW0taUk19TEYR9s1aNzxNyDYVVB6x2nhRkHpUm+yuOO74LSlQ1EJEX3eyG3pEOhAZpbBVJdua9aunok/L70ez6AcMmIiCubRVQ6kQrFJ6XYGV1VgyOgYQ64D/PsMkUr4PKcip5i0tkSmA43HlxfMSoH/M2rYNhB1MoyIGqP+Cf2c7gZ+9O+xgpw1CrKHIPQQIPvH+HFRq2d16rwlmcAUWpEJshsFC5AZ7XpAmKOv/63UGStWKnwsMHEoapd0kpTGoOiyS3+IMGdWDOYgFcvAoWlYE/qEVIswSUlolOInKjHv1edPby1F5T9gyJ8wefEtzqYHgUJ2VZllRQaOSEvNCKchSTMAuiaehPRuj4E2QNBGzdzG10UvRC2qv/ipOZJ//nXiT0ji39V2APO2gWI7QNl2ypt+mLrXwclpq+ccjs6apnC3iYv2HHyiyWr3WE0wyTwaipHG+luo/oDpt876ZqZVRbzQ1uXgy0k9w6pHa5tR2n6CtKZNLxrD1R5S+9YrMpCq1aSGWN/yrapYCipKqbaOHqzXU7B4Y7KqouXPJRqa591HfAFG+i8USgghLV0LHs8gs/tztbbFr67q0viaPTltO2pxvQhqxUl5VtIdj/gnXIXBX3VfRTxFEPSleruuH5wHzZ1J+MZpXjwo51XUvDFOEizcn8ret2hzOZ6cv6NcrUeBua+Z3MCSzgFYBiu1h8JTwK+teQZqXvqCwMOmlDqwS4w9Ini3juKwXgeJif6Eqqo2sDi6J2Sq6g+qiXH6
sidebar_class_name: "patch api-method"
info_path: docs/api/release
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a release"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/release/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update information for a release.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The ID of the release.","example":1234}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The status of the release.","enum":["active","pending","deprecated","failed","unstable"],"example":"active","title":"release_status"},"asset":{"type":"object","required":["id","buildId","type","url","metadata"],"properties":{"id":{"type":"integer","description":"The unique ID for the asset.","example":123},"buildId":{"type":"integer","description":"The unique ID of the build this asset belongs to.","example":456},"type":{"type":"string","description":"A string identifying the asset type.","example":"docker-image"},"url":{"type":"string","description":"A URL that locates or provides access to the asset.","example":"https://example.com/assets/456"},"metadata":{"type":"string","description":"Arbitrary data providing additional context for the asset."}},"title":"asset"}},"title":"release_write"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","semver","buildId","status","application_id","asset","created_at","updated_at"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the release.","example":789},"semver":{"type":"string","description":"A version identifier following Semantic Versioning (SemVer) conventions.\"","example":"1.0.1-rc1","title":"semver"},"buildId":{"type":"integer","description":"The ID of the build to be released.","example":456},"status":{"type":"string","description":"The status of the release.","enum":["active","pending","deprecated","failed","unstable"],"example":"active","title":"release_status"},"asset":{"type":"object","required":["id","buildId","type","url","metadata"],"properties":{"id":{"type":"integer","description":"The unique ID for the asset.","example":123},"buildId":{"type":"integer","description":"The unique ID of the build this asset belongs to.","example":456},"type":{"type":"string","description":"A string identifying the asset type.","example":"docker-image"},"url":{"type":"string","description":"A URL that locates or provides access to the asset.","example":"https://example.com/assets/456"},"metadata":{"type":"string","description":"Arbitrary data providing additional context for the asset."}},"title":"asset"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the entity was created.","example":"2023-10-01T12:34:56Z","title":"date"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the entity was created.","example":"2023-10-01T12:34:56Z","title":"date"}},"title":"release"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>