SHshorebird
releases

Update the release.

patch/apps/{appId}/releases/{releaseId}

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

status'draft' | 'active'

The status of a release.

platform'android' | 'ios' | 'linux' | 'macos' | 'windows'

A platform to which a Shorebird release can be deployed.

metadataobject

Additional information about the command that was run to update the release and the environment it was run in.

notesstring

Notes about the release. This is a free-form field that can be used to store additional information about the release. If null, the notes will not be updated.

Response

The release was updated.

Changes

No recorded changes to this operation across all 1 revision of this API.