Management API
Create a Workflow Stage Change
Create a workflow stage change. It is important to pass a story ID along with the object.
https://mapi.storyblok.com/v1/spaces/:space_id/workflow_stage_changes
Path Parameters
-
:space_id
required numberNumeric ID of a space
Request Body Properties
-
workflow_stage_change
objectAn object containing the workflow stage ID along with Story ID
-
workflow_stage_id
numberWorkflow stage ID to which the story is changed to
-
story_id
numberID of the story
-
Response Properties
-
workflow_stage_change
Workflow Stage Change ObjectThe workflow stage_change object
-
id
numberThe numeric ID of a workflow stage change
-
workflow_stage_id
numberWorkflow stage ID to which the story is changed to
-
created_at
stringCreation date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
user_id
numberID of the use that made the change
-
workflow_id
numberID of the workflow that the stage belongs to
-
Request
curl "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/" \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_OAUTH_TOKEN" \
-d "{\"workflow_stage_change\": {\"workflow_stage_id\": 123,\"story_id\": 123}}"
Request
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/space_id/workflow_stage_changes/', {
"workflow_stage_change": {
"workflow_stage_id": 123,
"story_id": 123
}
})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
Request
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');
$payload = [
"workflow_stage_change" => [
"workflow_stage_id" => 123,
"story_id" => 123
]
];
$client->post('/spaces/space_id/workflow_stage_changes/', $payload)->getBody();
Request
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
payload = {
"workflow_stage_change" => {
"workflow_stage_id" => 123,
"story_id" => 123
}
}
client.post('/spaces/space_id/workflow_stage_changes/', payload)
Request
HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/")
.header("Content-Type", "application/json")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.body("{\"workflow_stage_change\": {\"workflow_stage_id\": 123,\"story_id\": 123}}")
.asString();
Request
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"workflow_stage_change\": {\"workflow_stage_id\": 123,\"story_id\": 123}}", 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_stage_change\": {\"workflow_stage_id\": 123,\"story_id\": 123}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/")! 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()
Request
import requests
url = "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/"
querystring = {}
payload = "{\"workflow_stage_change\": {\"workflow_stage_id\": 123,\"story_id\": 123}}"
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 receive a workflow stage change object as a response.