Update a Workflow

PUT

https://mapi.storyblok.com/v1/spaces/:space_id/workflows/:workflow_id

This endpoint can be used to update a workflow using its numeric ID.

Path parameters

• :space_id required number

  Numeric ID of a space

• :workflow_id required number

  Numeric ID of the connected workflow. If empty while creating a new stage, then the stage is created in the default workflow.

Request body properties

• workflow Workflow Object

  A workflow object

Examples

Example Request

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/workflows/656" \
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"workflow\":{\"content_types\":[\"page\",\"teaser\"],\"name\":\"updated_name\"}}"

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/workflows/656', {
  "workflow": {
    "content_types": [
      "page",
      "teaser"
    ],
    "name": "updated_name"
  }
})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

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

$payload = ["workflow" => ["content_types" => ["page","teaser"],"name" => "updated_name"]];

$client->put('spaces/288868932106293/workflows/656', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/288868932106293/workflows/656")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"workflow":{"content_types":["page","teaser"],"name":"updated_name"}})
  .asString();

C#

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

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"workflow\":{\"content_types\":[\"page\",\"teaser\"],\"name\":\"updated_name\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/288868932106293/workflows/656"

querystring = {}

payload = {"workflow":{"content_types":["page","teaser"],"name":"updated_name"}}
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 = {"workflow" => {"content_types" => ["page","teaser"],"name" => "updated_name"}}

client.put('spaces/288868932106293/workflows/656', payload)

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
var request = URLRequest(storyblok: storyblok, path: "spaces/288868932106293/workflows/656")
request.httpMethod = "PUT"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "workflow": [
        "content_types": [
            "page",
            "teaser",
        ],
        "name": "updated_name",
    ],
])
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/workflows/656") {
    setBody(buildJsonObject {
        putJsonObject("workflow") {
            putJsonArray("content_types") {
                add("page")
                add("teaser")
            }
            put("name", "updated_name")
        }
    })
}

println(response.body<JsonElement>())