Update a Release

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

https://mapi.storyblok.com/v1/spaces/:space_id/releases/:release_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
- name
  string
  
  Name of the release
- release_at
  string
  
  Date to deploy the release (Format: YYYY-mm-dd HH:MM)
- timezone
  string
  
  Timezone of the release
- branches_to_deploy
  number[]
  
  An array of branches (pipeline stages) to deploy the release to
- users_to_notify_ids
  number[]
  
  An array of user IDs who should be notified of the release
do_release
boolean

Set true to deploy the release

Response Properties

release
The Release Object

The Release Object
- name
  string
  
  Name of the release
- id
  number
  
  Numeric ID of a release
- release_at
  string
  
  Date to deploy the release (Format: YYYY-mm-dd HH:MM)
- released
  boolean
  
  True if the release is released
- uuid
  string
  
  Unique ID of the release
- timezone
  string
  
  Timezone of the release
- branches_to_deploy
  number[]
  
  An array of branches (pipeline stages) to deploy the release to
- created_at
  string
  
  Date and time the release was created (Format: YYYY-mm-dd HH:MM)
- owner_id
  number
  
  Numeric ID of the release owner
- users_to_notify_ids
  number[]
  
  An array of user IDs who should be notified of the release

Select a Language

Request

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

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('/spaces/606/releases/123', {
  "release": {
    "name": "Summer Special",
    "release_at": "2025-01-01 01:01",
    "branches_to_deploy": [
      123,
      456
    ]
  },
  "do_release": true
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

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

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

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

Request

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

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

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

Request

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

Request

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

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

Request

import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{\"release\": {\"name\": \"Summer Special\",\"release_at\": \"2025-01-01 01:01\",\"branches_to_deploy\": [123,456]},\"do_release\": true}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/releases/123")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Request

import requests

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

querystring = {}

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

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

print(response.text)

Prev Create a Release

Next Delete a Release