Update a Workflow

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

https://mapi.storyblok.com/v1/spaces/:space_id/workflows/:workflow_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
- content_types
  string[]
  
  Array of content types associated with this workflow. At least one content type is required for a custom workflow.
- name
  string
  
  Workflow name

Select a Language

Example Request

Request

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

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('/paces/606/workflows/656', {
  "workflow": {
      "name": "updated_name",
      "content_types": ["page", "teaser"]
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

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

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

$client->put('/paces/606/workflows/656', $payload)->getBody();

Request

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

payload = {
  "workflow" =>  {
      "name" =>  "updated_name",
      "content_types" =>  ["page", "teaser"]
  }
}

client.put('/paces/606/workflows/656', payload)

Request

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

Request

var client = new RestClient("https://mapi.storyblok.com/v1/paces/606/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\": {\"name\": \"updated_name\",\"content_types\": [\"page\", \"teaser\"]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request

import Foundation

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

let postData = NSData(data: "{\"workflow\": {\"name\": \"updated_name\",\"content_types\": [\"page\", \"teaser\"]}}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/paces/606/workflows/656")! 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/paces/606/workflows/656"

querystring = {}

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

Next Delete a Workflow