Create a Workflow Stage Change

https://mapi.storyblok.com/v1/spaces/:space_id/workflow_stage_changes

Create a workflow stage change. It is important to pass a story ID along with the object.

Path parameters

• :space_id required number

  Numeric ID of a space

Request body properties

• workflow_stage_change object

  An object containing the workflow stage ID along with Story ID

• release_id number

  ID of the current release (can be requested with the from_release API parameter)

• notify boolean

  Notify the assigned user when the workflow is assigned. Defaults to false.

• comment object

  Comment object containing a message to notify the user about the workflow stage change.

• assign object

  An assign object containing space_role_ids and user_ids is used to assign a story stage to specific users or roles.

Response properties

• workflow_stage_change Workflow Stage Change Object

  The workflow stage_change object

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"workflow_stage_change\":{\"story_id\":123,\"workflow_stage_id\":123}}"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('spaces/space_id/workflow_stage_changes/', {
  "workflow_stage_change": {
    "story_id": 123,
    "workflow_stage_id": 123
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

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

$payload = ["workflow_stage_change" => ["story_id" => 123,"workflow_stage_id" => 123]];

$client->post('spaces/space_id/workflow_stage_changes/', $payload)->getBody();

Java

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":{"story_id":123,"workflow_stage_id":123}})
  .asString();

C#

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\":{\"story_id\":123,\"workflow_stage_id\":123}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/space_id/workflow_stage_changes/"

querystring = {}

payload = {"workflow_stage_change":{"story_id":123,"workflow_stage_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)

Ruby

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

payload = {"workflow_stage_change" => {"story_id" => 123,"workflow_stage_id" => 123}}

client.post('spaces/space_id/workflow_stage_changes/', payload)

Swift

import Foundation

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

let postData = NSData(data: {"workflow_stage_change":{"story_id":123,"workflow_stage_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()

You will receive a workflow stage change object as a response.