Skip to main content
POST
/
releases
Create a new release
curl --request POST \
  --url https://api.onset.io/v1/releases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "body": "<string>",
  "status": "DRAFT",
  "slug": "<string>",
  "is_public": true,
  "project_id": "<string>",
  "label_ids": [
    "<string>"
  ],
  "contributor_ids": [
    "<string>"
  ],
  "attachments": [
    {
      "id": "<string>",
      "type": "FILE",
      "content": {
        "title": "<string>",
        "url": "<string>",
        "size": 123,
        "type": "<string>"
      }
    }
  ],
  "hero": {
    "type": "image",
    "url": "<string>"
  },
  "changes": [
    {
      "id": "<string>",
      "changeId": "<string>",
      "content": "<string>"
    }
  ],
  "is_pinned": true,
  "is_pre_release": true,
  "version": "<string>"
}'
{
  "id": "<string>",
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "status": "DRAFT",
  "version": "<string>",
  "is_pinned": true,
  "is_public": true,
  "is_pre_release": true,
  "hero": null,
  "changes": [
    {
      "id": "<string>",
      "change_id": "<string>",
      "content": "<string>"
    }
  ],
  "project": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>"
  },
  "labels": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "color": "<string>"
    }
  ],
  "attachments": [
    {
      "type": "FILE",
      "content": {
        "title": "<string>",
        "url": "<string>",
        "size": 123,
        "type": "<string>"
      },
      "id": "<string>"
    }
  ],
  "contributors": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "released_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
title
string
required

Release title

Required string length: 3 - 255
status
enum<string>
required

Release status

Available options:
DRAFT,
RELEASED
slug
string
required

URL-friendly release identifier

Required string length: 3 - 255
body
string

Release description/body content

is_public
boolean

Whether release should be publicly visible

project_id
string

ID of the project this release belongs to

label_ids
string[]

Array of label IDs to attach to the release

contributor_ids
string[]

Array of contributor IDs to attach to the release

attachments
object[]

Array of attachments to include

  • Option 1
  • Option 2
hero
object

Hero image/video for the release

changes
object[]

List of changes in this release

is_pinned
boolean

Whether release should be pinned

is_pre_release
boolean

Whether this is a pre-release

version
string | null

Release version

Response

Release created successfully

id
string

Unique release identifier

title
string

Release title

body
string

Release description/body content (HTML formatted)

slug
string

URL-friendly release identifier

status
enum<string>

Current release status

Available options:
DRAFT,
RELEASED
version
string | null

Release version

is_pinned
boolean

Whether release is pinned

is_public
boolean

Whether release is publicly visible

is_pre_release
boolean

Whether this is a pre-release

hero
object | null

Hero image/video for the release

changes
object[]

List of changes in this release

project
object
labels
object[]
attachments
object[]
  • Option 1
  • Option 2
contributors
object[]

List of contributors to this release

released_at
string<date-time> | null

When the release was released

created_at
string<date-time>

When the release was created

updated_at
string<date-time>

When the release was last updated

I