> ## Documentation Index > Fetch the complete documentation index at: https://docs.onset.io/llms.txt > Use this file to discover all available pages before exploring further. # Update release > Update an existing release ## OpenAPI ````yaml https://api.onset.io/v1/openapi.yml patch /releases/{id} openapi: 3.1.0 info: title: Onset API description: >- RESTful API for managing milestones, releases, subscribers, and webhooks in Onset workspace. version: 1.0.0 contact: name: Onset Support url: https://www.onset.io email: support@onset.io license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.onset.io/v1 description: API V1 security: - bearerAuth: [] - basicAuth: [] tags: - name: Workspace description: Workspace management operations - name: Milestones description: Milestone management operations - name: Releases description: Release management operations - name: Subscribers description: Subscriber management operations - name: Webhooks description: Webhook management operations - name: Incoming Webhooks description: Incoming webhook management operations paths: /releases/{id}: patch: tags: - Releases summary: Update release description: Update an existing release parameters: - name: id in: path required: true description: Release ID schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateReleaseRequest' responses: '200': description: Release updated successfully content: application/json: schema: $ref: '#/components/schemas/Release' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: schemas: UpdateReleaseRequest: type: object properties: title: type: string minLength: 3 maxLength: 255 description: Release title body: type: string description: Release description/body content status: type: string enum: - DRAFT - RELEASED description: Release status slug: type: string minLength: 3 maxLength: 255 pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$ description: URL-friendly release identifier is_public: type: boolean description: Whether release should be publicly visible project_id: type: string nullable: true description: ID of the project this release belongs to label_ids: type: array items: type: string description: Array of label IDs to attach to the release contributor_ids: type: array items: type: string description: Array of contributor IDs to attach to the release attachments: type: array items: oneOf: - $ref: '#/components/schemas/CreateFileAttachmentRequest' - $ref: '#/components/schemas/CreateLinkAttachmentRequest' description: Array of attachments to include hero: oneOf: - type: 'null' - type: object properties: type: type: string enum: - image - video url: type: string format: uri required: - type - url description: Hero image/video for the release changes: type: array items: type: object properties: id: type: string change_id: type: string content: type: string description: HTML formatted content required: - id - change_id - content description: List of changes in this release contributors: type: array items: type: object properties: id: type: string name: type: string avatar_url: type: string format: uri required: - id - name - avatar_url description: List of contributors to this release is_pinned: type: boolean description: Whether release should be pinned is_pre_release: type: boolean description: Whether this is a pre-release version: type: string nullable: true description: Release version required: - title - status - slug Release: type: object properties: id: type: string description: Unique release identifier title: type: string description: Release title body: type: string description: Release description/body content (HTML formatted) slug: type: string description: URL-friendly release identifier status: type: string enum: - DRAFT - RELEASED description: Current release status version: type: string nullable: true description: Release version is_pinned: type: boolean description: Whether release is pinned is_public: type: boolean description: Whether release is publicly visible is_pre_release: type: boolean description: Whether this is a pre-release summary: type: string nullable: true description: AI generated summary of the release hero: oneOf: - type: 'null' - type: object properties: type: type: string enum: - image - video url: type: string format: uri description: Hero image/video for the release changes: type: array items: type: object properties: id: type: string description: Change ID change_id: type: string description: Change type ID content: type: string description: Change content (HTML formatted) description: List of changes in this release project: allOf: - $ref: '#/components/schemas/Project' - nullable: true labels: type: array items: $ref: '#/components/schemas/Label' attachments: type: array items: $ref: '#/components/schemas/Attachment' contributors: type: array items: type: object properties: id: type: string description: Contributor ID name: type: string description: Contributor name avatar_url: type: string format: uri description: Contributor avatar URL description: List of contributors to this release released_at: type: string format: date-time nullable: true description: When the release was released created_at: type: string format: date-time description: When the release was created updated_at: type: string format: date-time description: When the release was last updated CreateFileAttachmentRequest: type: object properties: id: type: string description: Optional existing attachment ID for updates type: type: string enum: - FILE content: type: object properties: title: type: string description: File title url: type: string description: File URL path size: type: integer description: File size in bytes type: type: string description: MIME type of the file required: - title - url - size - type required: - type - content CreateLinkAttachmentRequest: type: object properties: id: type: string description: Optional existing attachment ID for updates type: type: string enum: - LINK content: type: object properties: title: type: string nullable: true description: Link title url: type: string format: uri description: Link URL required: - url required: - type - content Project: type: object properties: id: type: string description: Unique project identifier name: type: string description: Project name slug: type: string description: Project slug Label: type: object properties: id: type: string description: Unique label identifier name: type: string description: Label name slug: type: string description: Label slug color: type: string description: Label color (hex code) Attachment: type: object discriminator: propertyName: type properties: id: type: string description: Unique attachment identifier type: type: string enum: - FILE - LINK description: Type of attachment oneOf: - $ref: '#/components/schemas/FileAttachment' - $ref: '#/components/schemas/LinkAttachment' ErrorResponse: type: object properties: error: type: string description: Error message details: type: object description: Additional error details required: - error FileAttachment: type: object properties: type: type: string enum: - FILE content: type: object properties: title: type: string description: File title url: type: string description: File URL path size: type: integer description: File size in bytes type: type: string description: MIME type of the file LinkAttachment: type: object properties: type: type: string enum: - LINK content: type: object properties: title: type: string nullable: true description: Link title url: type: string format: uri description: Link URL responses: BadRequest: description: Bad request - Invalid input parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Unauthorized - Invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Not found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer ````