Update a Release

PUT

https://mapi.storyblok.com/v1/spaces/:space_id/releases/:release_id

This endpoint allows you to update a release using the numeric ID.

Path parameters

• :space_id required number

  Numeric ID of a space

• :release_id required number

  Numeric ID of the release

Request body properties

• release The Release Object

  The Release Object

• do_release boolean

  Set true to deploy the release

Response properties

• release The Release Object

  The Release Object

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/releases/123" \
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"do_release\":true,\"release\":{\"branches_to_deploy\":[123,456],\"name\":\"Summer Special\",\"release_at\":\"2025-01-01 01:01\"}}"

JS

// storyblok-js-client@>=7, node@>=18
import Storyblok from "storyblok-js-client";

const storyblok = new Storyblok({
  oauthToken: "YOUR_PERSONAL_ACCESS_TOKEN",
});

try {
  const response = await storyblok.put('spaces/288868932106293/releases/123', {
  "do_release": true,
  "release": {
    "branches_to_deploy": [
      123,
      456
    ],
    "name": "Summer Special",
    "release_at": "2025-01-01 01:01"
  }
})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = ["do_release" => true,"release" => ["branches_to_deploy" => [123,456],"name" => "Summer Special","release_at" => "2025-01-01 01 => 01"]];

$client->put('spaces/288868932106293/releases/123', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/288868932106293/releases/123")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"do_release":true,"release":{"branches_to_deploy":[123,456],"name":"Summer Special","release_at":"2025-01-01 01:01"}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/288868932106293/releases/123");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"do_release\":true,\"release\":{\"branches_to_deploy\":[123,456],\"name\":\"Summer Special\",\"release_at\":\"2025-01-01 01:01\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/288868932106293/releases/123"

querystring = {}

payload = {"do_release":true,"release":{"branches_to_deploy":[123,456],"name":"Summer Special","release_at":"2025-01-01 01:01"}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {"do_release" => true,"release" => {"branches_to_deploy" => [123,456],"name" => "Summer Special","release_at" => "2025-01-01 01 => 01"}}

client.put('spaces/288868932106293/releases/123', payload)

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
var request = URLRequest(storyblok: storyblok, path: "spaces/288868932106293/releases/123")
request.httpMethod = "PUT"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "do_release": true,
    "release": [
        "branches_to_deploy": [
            123,
            456,
        ],
        "name": "Summer Special",
        "release_at": "2025-01-01 01:01",
    ],
])
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = OAuth("YOUR_OAUTH_TOKEN")
    }
}

val response = client.put("spaces/288868932106293/releases/123") {
    setBody(buildJsonObject {
        put("do_release", true)
        putJsonObject("release") {
            putJsonArray("branches_to_deploy") {
                add(123)
                add(456)
            }
            put("name", "Summer Special")
            put("release_at", "2025-01-01 01:01")
        }
    })
}

println(response.body<JsonElement>())