Create and Manage Folders

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

Use the Story endpoint to create and manage content folders.

You can use a small subset of properties from the Story Object to push new folders into your space or modify their configurations:

• Use name and slug to identify the folder.
• Always pass true to the is_folder in the Request Body.
• Use parent_id to determine where the folder should be created.
• You can also update existent folders to accept only specific content types.

Check the request examples in this section.

Path parameters

• :space_id required number

  Numeric ID of a space

Request body properties

• story The Story Object

  A single story object

Response properties

• story The Story Object

  A single story object

Examples

Create a new folder within your Space.

cURL

curl "https://mapi.storyblok.com/v1/spaces/606/stories" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"story\":{\"is_folder\":true,\"name\":\"A new folder\",\"parent_id\":0,\"slug\":\"a-new-folder\"}}"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('spaces/606/stories', {
  "story": {
    "is_folder": true,
    "name": "A new folder",
    "parent_id": 0,
    "slug": "a-new-folder"
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

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

$payload = ["story" => ["is_folder" => true,"name" => "A new folder","parent_id" => 0,"slug" => "a-new-folder"]];

$client->post('spaces/606/stories', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/606/stories")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"story":{"is_folder":true,"name":"A new folder","parent_id":0,"slug":"a-new-folder"}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/stories");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"story\":{\"is_folder\":true,\"name\":\"A new folder\",\"parent_id\":0,\"slug\":\"a-new-folder\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/606/stories"

querystring = {}

payload = {"story":{"is_folder":true,"name":"A new folder","parent_id":0,"slug":"a-new-folder"}}
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 = {"story" => {"is_folder" => true,"name" => "A new folder","parent_id" => 0,"slug" => "a-new-folder"}}

client.post('spaces/606/stories', payload)

Swift

import Foundation

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

let postData = NSData(data: {"story":{"is_folder":true,"name":"A new folder","parent_id":0,"slug":"a-new-folder"}}.data(using: String.Encoding.utf8)!)

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

Create a folder to accept only a certain content type using the default_root property.

cURL

curl "https://mapi.storyblok.com/v1/spaces/606/stories" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "\"{\n  story: {\n    default_root: \\"article\\",\n    is_folder: true,\n    name: \\"A new folder\\",\n    parent_id: 0,\n    slug: \\"a-new-folder\\",\n  },\n}\""

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('spaces/606/stories', "{\n  story: {\n    default_root: \"article\",\n    is_folder: true,\n    name: \"A new folder\",\n    parent_id: 0,\n    slug: \"a-new-folder\",\n  },\n}")
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

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

$payload = "[\n  story =>  [\n    default_root =>  \"article\",\n    is_folder =>  true,\n    name =>  \"A new folder\",\n    parent_id =>  0,\n    slug =>  \"a-new-folder\",\n  ],\n]";

$client->post('spaces/606/stories', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/606/stories")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\n  story: {\n    default_root: \"article\",\n    is_folder: true,\n    name: \"A new folder\",\n    parent_id: 0,\n    slug: \"a-new-folder\",\n  },\n}")
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/stories");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "\"{\\n  story: {\\n    default_root: \\\"article\\\",\\n    is_folder: true,\\n    name: \\\"A new folder\\\",\\n    parent_id: 0,\\n    slug: \\\"a-new-folder\\\",\\n  },\\n}\"", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/606/stories"

querystring = {}

payload = "{\n  story: {\n    default_root: \"article\",\n    is_folder: true,\n    name: \"A new folder\",\n    parent_id: 0,\n    slug: \"a-new-folder\",\n  },\n}"
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 = "{\n  story =>  {\n    default_root =>  \"article\",\n    is_folder =>  true,\n    name =>  \"A new folder\",\n    parent_id =>  0,\n    slug =>  \"a-new-folder\",\n  },\n}"

client.post('spaces/606/stories', payload)

Swift

import Foundation

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

let postData = NSData(data: "{\n  story: {\n    default_root: \"article\",\n    is_folder: true,\n    name: \"A new folder\",\n    parent_id: 0,\n    slug: \"a-new-folder\",\n  },\n}".data(using: String.Encoding.utf8)!)

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

Update a folder with strict content types.

cURL

curl "https://mapi.storyblok.com/v1/spaces/606/stories" \
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"story\":{\"content\":{\"content_types\":[\"category\"],\"lock_subfolders_content_types\":false},\"is_folder\":true,\"name\":\"Categories\",\"parent_id\":0,\"slug\":\"categories\"}}"

JS client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('spaces/606/stories', {
  "story": {
    "content": {
      "content_types": [
        "category"
      ],
      "lock_subfolders_content_types": false
    },
    "is_folder": true,
    "name": "Categories",
    "parent_id": 0,
    "slug": "categories"
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

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

$payload = ["story" => ["content" => ["content_types" => ["category"],"lock_subfolders_content_types" => false],"is_folder" => true,"name" => "Categories","parent_id" => 0,"slug" => "categories"]];

$client->put('spaces/606/stories', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/606/stories")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"story":{"content":{"content_types":["category"],"lock_subfolders_content_types":false},"is_folder":true,"name":"Categories","parent_id":0,"slug":"categories"}})
  .asString();

C#

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

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"story\":{\"content\":{\"content_types\":[\"category\"],\"lock_subfolders_content_types\":false},\"is_folder\":true,\"name\":\"Categories\",\"parent_id\":0,\"slug\":\"categories\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/606/stories"

querystring = {}

payload = {"story":{"content":{"content_types":["category"],"lock_subfolders_content_types":false},"is_folder":true,"name":"Categories","parent_id":0,"slug":"categories"}}
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 = {"story" => {"content" => {"content_types" => ["category"],"lock_subfolders_content_types" => false},"is_folder" => true,"name" => "Categories","parent_id" => 0,"slug" => "categories"}}

client.put('spaces/606/stories', payload)

Swift

import Foundation

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

let postData = NSData(data: {"story":{"content":{"content_types":["category"],"lock_subfolders_content_types":false},"is_folder":true,"name":"Categories","parent_id":0,"slug":"categories"}}.data(using: String.Encoding.utf8)!)

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