Create a Workflow Stage
Create a workflow stage
spaces/:space_id/workflow_stages
Path Parameters
-
:space_id
required numberNumeric id of a space
Request Body Properties
-
workflow_stage_object
Workflow Stage Object-
id
numberThe numeric ID
-
after_publish_id
numberWorkflow stage id that gets assigned after publishing
-
allow_publish
booleanBoolean to allow publishing
-
is_default
booleanBoolean to set as the default workflow
-
position
numberNumeric representation of the story's position in the folder
-
allow_all_stages
booleanBoolean to allow all stages
-
allow_all_users
booleanBoolean to allow change to all users
-
name
stringWorkflow name
-
color
stringWorkflow color
-
user_ids
numberAn array of user ids that are allowed to change the stage
-
space_role_ids
number[]Space role ids that are allowed to change the stage
-
workflow_stage_ids
numberAn array of workflow stage ids the user can change the stage to
-
workflow_id
numberNumeric ID of the connected workflow
-
allow_admin_change
booleanAllow admins to change from the current stage to the next available stages
-
allow_editor_change
booleanAllow editors to change from the current stage to the next available stages
-
Response Properties
-
workflow_stage_object
Workflow Stage Object-
id
numberThe numeric ID
-
after_publish_id
numberWorkflow stage id that gets assigned after publishing
-
allow_publish
booleanBoolean to allow publishing
-
is_default
booleanBoolean to set as the default workflow
-
position
numberNumeric representation of the story's position in the folder
-
allow_all_stages
booleanBoolean to allow all stages
-
allow_all_users
booleanBoolean to allow change to all users
-
name
stringWorkflow name
-
color
stringWorkflow color
-
user_ids
numberAn array of user ids that are allowed to change the stage
-
space_role_ids
number[]Space role ids that are allowed to change the stage
-
workflow_stage_ids
numberAn array of workflow stage ids the user can change the stage to
-
workflow_id
numberNumeric ID of the connected workflow
-
allow_admin_change
booleanAllow admins to change from the current stage to the next available stages
-
allow_editor_change
booleanAllow editors to change from the current stage to the next available stages
-
curl "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stages" \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_OAUTH_TOKEN" \
-d "{\"workflow_stage\":{\"after_publish_id\":[],\"allow_publish\":[],\"is_default\":false,\"position\":0,\"allow_all_stages\":true,\"allow_all_users\":true,\"name\":\"Ready to Publish\",\"color\":\"#333\",\"user_ids\":[],\"space_role_ids\":[],\"workflow_stage_ids\":[]\"workflow_id\": 14780}}"
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/space_id/workflow_stages', {
"workflow_stage":{
"after_publish_id":[],
"allow_publish":[],
"is_default":false,
"position":0,
"allow_all_stages":true,
"allow_all_users":true,
"name":"Ready to Publish",
"color":"#333",
"user_ids":[],
"space_role_ids":[],
"workflow_stage_ids":[]
"workflow_id": 14780
}
})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
$client = new \Storyblok\Client('YOUR_STORYBLOK_SPACE_ACCESS_TOKEN');
$payload = [
"workflow_stage" => [
"after_publish_id" => [],
"allow_publish" => [],
"is_default" => false,
"position" => 0,
"allow_all_stages" => true,
"allow_all_users" => true,
"name" => "Ready to Publish",
"color" => "#333",
"user_ids" => [],
"space_role_ids" => [],
"workflow_stage_ids" => []
"workflow_id" => 14780
]
];
$client->post('/spaces/space_id/workflow_stages', $payload)->getBody();
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
payload = {
"workflow_stage" => {
"after_publish_id" => [],
"allow_publish" => [],
"is_default" => false,
"position" => 0,
"allow_all_stages" => true,
"allow_all_users" => true,
"name" => "Ready to Publish",
"color" => "#333",
"user_ids" => [],
"space_role_ids" => [],
"workflow_stage_ids" => []
"workflow_id" => 14780
}
}
client.post('/spaces/space_id/workflow_stages', payload)
HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/space_id/workflow_stages")
.header("Content-Type", "application/json")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.body("{\"workflow_stage\":{\"after_publish_id\":[],\"allow_publish\":[],\"is_default\":false,\"position\":0,\"allow_all_stages\":true,\"allow_all_users\":true,\"name\":\"Ready to Publish\",\"color\":\"#333\",\"user_ids\":[],\"space_role_ids\":[],\"workflow_stage_ids\":[]\"workflow_id\": 14780}}")
.asString();
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/space_id/workflow_stages");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"workflow_stage\":{\"after_publish_id\":[],\"allow_publish\":[],\"is_default\":false,\"position\":0,\"allow_all_stages\":true,\"allow_all_users\":true,\"name\":\"Ready to Publish\",\"color\":\"#333\",\"user_ids\":[],\"space_role_ids\":[],\"workflow_stage_ids\":[]\"workflow_id\": 14780}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
import Foundation
let headers = [
"Content-Type": "application/json",
"Authorization": "YOUR_OAUTH_TOKEN"
]
let postData = NSData(data: "{\"workflow_stage\":{\"after_publish_id\":[],\"allow_publish\":[],\"is_default\":false,\"position\":0,\"allow_all_stages\":true,\"allow_all_users\":true,\"name\":\"Ready to Publish\",\"color\":\"#333\",\"user_ids\":[],\"space_role_ids\":[],\"workflow_stage_ids\":[]\"workflow_id\": 14780}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stages")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "POST"
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()
import requests
url = "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stages"
querystring = {}
payload = "{\"workflow_stage\":{\"after_publish_id\":[],\"allow_publish\":[],\"is_default\":false,\"position\":0,\"allow_all_stages\":true,\"allow_all_users\":true,\"name\":\"Ready to Publish\",\"color\":\"#333\",\"user_ids\":[],\"space_role_ids\":[],\"workflow_stage_ids\":[]\"workflow_id\": 14780}}"
headers = {
'Content-Type': "application/json",
'Authorization': "YOUR_OAUTH_TOKEN"
}
response = requests.request("POST", url, data=payload, headers=headers, params=querystring)
print(response.text)
You will an array of workflow stages as response.