Update release

Update release

curl --request PATCH \
  --url https://api.onset.io/v1/releases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "is_public": true,
  "project_id": "<string>",
  "label_ids": [
    "<string>"
  ],
  "contributor_ids": [
    "<string>"
  ],
  "attachments": [
    {
      "type": "FILE",
      "content": {
        "title": "<string>",
        "url": "<string>",
        "size": 123,
        "type": "<string>"
      },
      "id": "<string>"
    }
  ],
  "changes": [
    {
      "title": "<string>",
      "content": "<string>"
    }
  ],
  "contributors": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "is_pinned": true,
  "is_pre_release": true,
  "version": "<string>"
}
'

import requests

url = "https://api.onset.io/v1/releases/{id}"

payload = {
    "title": "<string>",
    "body": "<string>",
    "slug": "<string>",
    "is_public": True,
    "project_id": "<string>",
    "label_ids": ["<string>"],
    "contributor_ids": ["<string>"],
    "attachments": [
        {
            "type": "FILE",
            "content": {
                "title": "<string>",
                "url": "<string>",
                "size": 123,
                "type": "<string>"
            },
            "id": "<string>"
        }
    ],
    "changes": [
        {
            "title": "<string>",
            "content": "<string>"
        }
    ],
    "contributors": [
        {
            "id": "<string>",
            "name": "<string>",
            "avatar_url": "<string>"
        }
    ],
    "is_pinned": True,
    "is_pre_release": True,
    "version": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    body: JSON.stringify('<string>'),
    slug: '<string>',
    is_public: true,
    project_id: '<string>',
    label_ids: ['<string>'],
    contributor_ids: ['<string>'],
    attachments: [
      {
        type: 'FILE',
        content: {title: '<string>', url: '<string>', size: 123, type: '<string>'},
        id: '<string>'
      }
    ],
    changes: [{title: '<string>', content: '<string>'}],
    contributors: [{id: '<string>', name: '<string>', avatar_url: '<string>'}],
    is_pinned: true,
    is_pre_release: true,
    version: '<string>'
  })
};

fetch('https://api.onset.io/v1/releases/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onset.io/v1/releases/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'body' => '<string>',
    'slug' => '<string>',
    'is_public' => true,
    'project_id' => '<string>',
    'label_ids' => [
        '<string>'
    ],
    'contributor_ids' => [
        '<string>'
    ],
    'attachments' => [
        [
                'type' => 'FILE',
                'content' => [
                                'title' => '<string>',
                                'url' => '<string>',
                                'size' => 123,
                                'type' => '<string>'
                ],
                'id' => '<string>'
        ]
    ],
    'changes' => [
        [
                'title' => '<string>',
                'content' => '<string>'
        ]
    ],
    'contributors' => [
        [
                'id' => '<string>',
                'name' => '<string>',
                'avatar_url' => '<string>'
        ]
    ],
    'is_pinned' => true,
    'is_pre_release' => true,
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onset.io/v1/releases/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"is_public\": true,\n  \"project_id\": \"<string>\",\n  \"label_ids\": [\n    \"<string>\"\n  ],\n  \"contributor_ids\": [\n    \"<string>\"\n  ],\n  \"attachments\": [\n    {\n      \"type\": \"FILE\",\n      \"content\": {\n        \"title\": \"<string>\",\n        \"url\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"changes\": [\n    {\n      \"title\": \"<string>\",\n      \"content\": \"<string>\"\n    }\n  ],\n  \"contributors\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"avatar_url\": \"<string>\"\n    }\n  ],\n  \"is_pinned\": true,\n  \"is_pre_release\": true,\n  \"version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onset.io/v1/releases/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"is_public\": true,\n  \"project_id\": \"<string>\",\n  \"label_ids\": [\n    \"<string>\"\n  ],\n  \"contributor_ids\": [\n    \"<string>\"\n  ],\n  \"attachments\": [\n    {\n      \"type\": \"FILE\",\n      \"content\": {\n        \"title\": \"<string>\",\n        \"url\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"changes\": [\n    {\n      \"title\": \"<string>\",\n      \"content\": \"<string>\"\n    }\n  ],\n  \"contributors\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"avatar_url\": \"<string>\"\n    }\n  ],\n  \"is_pinned\": true,\n  \"is_pre_release\": true,\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onset.io/v1/releases/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"is_public\": true,\n  \"project_id\": \"<string>\",\n  \"label_ids\": [\n    \"<string>\"\n  ],\n  \"contributor_ids\": [\n    \"<string>\"\n  ],\n  \"attachments\": [\n    {\n      \"type\": \"FILE\",\n      \"content\": {\n        \"title\": \"<string>\",\n        \"url\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"changes\": [\n    {\n      \"title\": \"<string>\",\n      \"content\": \"<string>\"\n    }\n  ],\n  \"contributors\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"avatar_url\": \"<string>\"\n    }\n  ],\n  \"is_pinned\": true,\n  \"is_pre_release\": true,\n  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "status": "DRAFT",
  "version": "<string>",
  "is_pinned": true,
  "is_public": true,
  "is_pre_release": true,
  "summary": "<string>",
  "hero": {
    "type": "image",
    "url": "<string>"
  },
  "changes": [
    {
      "title": "<string>",
      "color": "<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>"
    }
  ],
  "scheduled_at": "2023-11-07T05:31:56Z",
  "released_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "details": {}
}

PATCH

releases

{id}

Update release

curl --request PATCH \
  --url https://api.onset.io/v1/releases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "is_public": true,
  "project_id": "<string>",
  "label_ids": [
    "<string>"
  ],
  "contributor_ids": [
    "<string>"
  ],
  "attachments": [
    {
      "type": "FILE",
      "content": {
        "title": "<string>",
        "url": "<string>",
        "size": 123,
        "type": "<string>"
      },
      "id": "<string>"
    }
  ],
  "changes": [
    {
      "title": "<string>",
      "content": "<string>"
    }
  ],
  "contributors": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "is_pinned": true,
  "is_pre_release": true,
  "version": "<string>"
}
'

import requests

url = "https://api.onset.io/v1/releases/{id}"

payload = {
    "title": "<string>",
    "body": "<string>",
    "slug": "<string>",
    "is_public": True,
    "project_id": "<string>",
    "label_ids": ["<string>"],
    "contributor_ids": ["<string>"],
    "attachments": [
        {
            "type": "FILE",
            "content": {
                "title": "<string>",
                "url": "<string>",
                "size": 123,
                "type": "<string>"
            },
            "id": "<string>"
        }
    ],
    "changes": [
        {
            "title": "<string>",
            "content": "<string>"
        }
    ],
    "contributors": [
        {
            "id": "<string>",
            "name": "<string>",
            "avatar_url": "<string>"
        }
    ],
    "is_pinned": True,
    "is_pre_release": True,
    "version": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    body: JSON.stringify('<string>'),
    slug: '<string>',
    is_public: true,
    project_id: '<string>',
    label_ids: ['<string>'],
    contributor_ids: ['<string>'],
    attachments: [
      {
        type: 'FILE',
        content: {title: '<string>', url: '<string>', size: 123, type: '<string>'},
        id: '<string>'
      }
    ],
    changes: [{title: '<string>', content: '<string>'}],
    contributors: [{id: '<string>', name: '<string>', avatar_url: '<string>'}],
    is_pinned: true,
    is_pre_release: true,
    version: '<string>'
  })
};

fetch('https://api.onset.io/v1/releases/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onset.io/v1/releases/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'body' => '<string>',
    'slug' => '<string>',
    'is_public' => true,
    'project_id' => '<string>',
    'label_ids' => [
        '<string>'
    ],
    'contributor_ids' => [
        '<string>'
    ],
    'attachments' => [
        [
                'type' => 'FILE',
                'content' => [
                                'title' => '<string>',
                                'url' => '<string>',
                                'size' => 123,
                                'type' => '<string>'
                ],
                'id' => '<string>'
        ]
    ],
    'changes' => [
        [
                'title' => '<string>',
                'content' => '<string>'
        ]
    ],
    'contributors' => [
        [
                'id' => '<string>',
                'name' => '<string>',
                'avatar_url' => '<string>'
        ]
    ],
    'is_pinned' => true,
    'is_pre_release' => true,
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onset.io/v1/releases/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"is_public\": true,\n  \"project_id\": \"<string>\",\n  \"label_ids\": [\n    \"<string>\"\n  ],\n  \"contributor_ids\": [\n    \"<string>\"\n  ],\n  \"attachments\": [\n    {\n      \"type\": \"FILE\",\n      \"content\": {\n        \"title\": \"<string>\",\n        \"url\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"changes\": [\n    {\n      \"title\": \"<string>\",\n      \"content\": \"<string>\"\n    }\n  ],\n  \"contributors\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"avatar_url\": \"<string>\"\n    }\n  ],\n  \"is_pinned\": true,\n  \"is_pre_release\": true,\n  \"version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onset.io/v1/releases/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"is_public\": true,\n  \"project_id\": \"<string>\",\n  \"label_ids\": [\n    \"<string>\"\n  ],\n  \"contributor_ids\": [\n    \"<string>\"\n  ],\n  \"attachments\": [\n    {\n      \"type\": \"FILE\",\n      \"content\": {\n        \"title\": \"<string>\",\n        \"url\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"changes\": [\n    {\n      \"title\": \"<string>\",\n      \"content\": \"<string>\"\n    }\n  ],\n  \"contributors\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"avatar_url\": \"<string>\"\n    }\n  ],\n  \"is_pinned\": true,\n  \"is_pre_release\": true,\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onset.io/v1/releases/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"is_public\": true,\n  \"project_id\": \"<string>\",\n  \"label_ids\": [\n    \"<string>\"\n  ],\n  \"contributor_ids\": [\n    \"<string>\"\n  ],\n  \"attachments\": [\n    {\n      \"type\": \"FILE\",\n      \"content\": {\n        \"title\": \"<string>\",\n        \"url\": \"<string>\",\n        \"size\": 123,\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"changes\": [\n    {\n      \"title\": \"<string>\",\n      \"content\": \"<string>\"\n    }\n  ],\n  \"contributors\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"avatar_url\": \"<string>\"\n    }\n  ],\n  \"is_pinned\": true,\n  \"is_pre_release\": true,\n  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "status": "DRAFT",
  "version": "<string>",
  "is_pinned": true,
  "is_public": true,
  "is_pre_release": true,
  "summary": "<string>",
  "hero": {
    "type": "image",
    "url": "<string>"
  },
  "changes": [
    {
      "title": "<string>",
      "color": "<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>"
    }
  ],
  "scheduled_at": "2023-11-07T05:31:56Z",
  "released_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Release ID

Body

application/json

Partial update. Every field is optional and any field you omit is left unchanged. Send an explicit empty array to clear label_ids, contributor_ids, attachments or changes.

title

string

Release title

Required string length: 3 - 255

body

string

Release description/body content

slug

string

URL-friendly release identifier

Required string length: 3 - 255

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

is_public

boolean

Whether release should be publicly visible

project_id

string | null

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

Show child attributes

hero

object

Hero image/video for the release. Omit to leave the current hero unchanged. null is not accepted, and the hero cannot be removed through this endpoint.

Show child attributes

changes

object[]

List of changes in this release

Show child attributes

contributors

object[]

List of contributors to this release

Show child attributes

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 updated successfully

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,

SCHEDULED,

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

summary

string | null

AI generated summary of the release

hero

null | object

Hero image/video for the release

Show child attributes

changes

object[]

List of changes in this release

Show child attributes

project

object

Show child attributes

labels

object[]

Show child attributes

attachments

object[]

Option 1
Option 2

Show child attributes

contributors

object[]

List of contributors to this release

Show child attributes

scheduled_at

string<date-time> | null

When the release is scheduled to publish. Only set while status is SCHEDULED.

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

Getting started

Releases

Audience

Page

Developers

Integrations

Authorizations

Path Parameters

Body

Response