Import a Story

Importing a story can be done using a PUT request for each story you want to import.

https://mapi.storyblok.com/v1/spaces/:space_id/stories/:story_id/import.json

Importing stories is available exclusively on the Business plan and higher. Please refer to Storyblok's Pricing for further information.

Path Parameters

:space_id
required number

Numeric ID of a space
:story_id
required number

The numeric id of story

Query Parameters

lang_code
string

A language code
import_lang
boolean

It shows to import language code or not.

Request Body Properties

story
The Story Object

A single story object
- name
  required string
  
  The complete name provided for the story
- parent_id
  number
  
  ID of the parent folder
- group_id
  string
  
  Group ID (UUID string), shared between stories defined as alternates
- sort_by_date
  string
  
  Date defined in the story's entry configuration (Format: YYYY-mm-dd)
- tag_list
  string[]
  
  Array of tag names
- is_folder
  boolean
  
  true if the instance constitutes a folder
- content
  object
  
  An object containing the field data associated with the specific story type's specific content structure. Also includes a component property with the story type's technical name.
- slug
  required string
  
  The slug specific for the story
- path
  string
  
  Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)
- default_root
  string
  
  Component name which will be used as default content type for this folders entries
- disable_fe_editor
  boolean
  
  Is side by side editor disabled for all entries in folder
- is_startpage
  boolean
  
  true if the story is defined as root for the folder
- meta_data
  object
  
  Object to store non-editable data that is exclusively maintained with the Management API
- pinned
  boolean
  
  To pin the story in the toolbar
- first_published_at
  string
  
  First publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- position
  number
  
  Numeric representation of the story's position in the folder

Response Properties

story
The Story Object

A single story object
- id
  number
  
  Numeric id of the story
- name
  string
  
  The complete name provided for the story
- parent_id
  number
  
  ID of the parent folder
- group_id
  string
  
  Group ID (UUID string), shared between stories defined as alternates
- alternates
  object[]
  
  An array containing objects that provide basic data of the stories defined as alternates of the current story
  - id
    number
    
    The numeric ID
  - name
    string
    
    The complete name provided for the story
  - slug
    string
    
    The slug specific for the story
  - published
    boolean
    
    true if a story has been published at least once (even if it is currently in draft)
  - full_slug
    string
    
    The full slug of the story, combining the parent folder(s) and the designated story slug
  - is_folder
    boolean
    
    true if the instance constitutes a folder
- created_at
  string
  
  Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- deleted_at
  string
  
  Deleted date (Format: YYYY-mm-dd HH:MM)
- sort_by_date
  string
  
  Date defined in the story's entry configuration (Format: YYYY-mm-dd)
- tag_list
  string[]
  
  Array of tag names
- updated_at
  string
  
  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- published_at
  string
  
  Latest publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- uuid
  string
  
  Generated UUID string
- is_folder
  boolean
  
  true if the instance constitutes a folder
- content
  object
  
  An object containing the field data associated with the specific story type's specific content structure. Also includes a component property with the story type's technical name.
- published
  boolean
  
  true if a story has been published at least once (even if it is currently in draft)
- slug
  string
  
  The slug specific for the story
- path
  string
  
  Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)
- full_slug
  string
  
  The full slug of the story, combining the parent folder(s) and the designated story slug
- default_root
  string
  
  Component name which will be used as default content type for this folders entries
- disable_fe_editor
  boolean
  
  Is side by side editor disabled for all entries in folder
- parent
  object
  
  Essential parent information as object (resolved from parent_id)
- is_startpage
  boolean
  
  true if the story is defined as root for the folder
- unpublished_changes
  boolean
  
  Story has unpublished changes; saved but not published
- meta_data
  object
  
  Object to store non-editable data that is exclusively maintained with the Management API
- imported_at
  string
  
  Latest import date (Format: YYYY-mm-dd HH:MM)
- preview_token
  object
  
  Preview token
  - token
    string
    
    The token passed to the editor as preview parameter to allow edit mode verification
  - timestamp
    string
    
    Timestamp passed to the editor as preview parameter to allow edit mode verification
- pinned
  boolean
  
  To pin the story in the toolbar
- breadcrumbs
  object[]
  
  Array of resolved subset of link objects (one per path segment / parent)
  - id
    number
    
    Story ID
  - name
    string
    
    The complete name provided for the story
  - parent_id
    number
    
    ID of the parent folder
  - disable_fe_editor
    boolean
    
    Is side by side editor disabled for all entries in folder
  - path
    string
    
    Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)
  - slug
    string
    
    The slug specific for the story
  - translated_slugs
    object[]
    
    Array of translated slug objects (if the app Translatable Slugs is installed)
- first_published_at
  string
  
  First publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- last_author
  object
  
  Last author
  - id
    number
    
    Last author user object numeric id
  - userid
    string
    
    Last author userid/username
  - friendly_name
    string
    
    Friendly name of last author
- last_author_id
  number
  
  Id of the last Author
- translated_slugs
  object[]
  
  Array of translated slug objects (if the app Translatable Slugs is installed)
  - story_id
    number
    
    ID of the story
  - lang
    string
    
    Language code of the current language (can be requested with the language API parameter)
  - slug
    string
    
    The slug specific for the story
  - name
    string
    
    The complete name provided for the story
  - published
    boolean
    
    true if a story has been published at least once (even if it is currently in draft)
- localized_paths
  object[]
  
  An array of translated path objects
  - path
    string
    
    Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)
  - name
    string
    
    The complete name provided for the story
  - lang
    string
    
    Language code of the current language (can be requested with the language API parameter)
  - published
    boolean
    
    true if a story has been published at least once (even if it is currently in draft)
- position
  number
  
  Numeric representation of the story's position in the folder
- release_id
  number
  
  ID of the current release (can be requested with the from_release API parameter)
- scheduled_dates
  string
  
  Scheduled publishing date (Format: YYYY-mm-dd HH:MM)
- favourite_for_user_ids
  number[]
  
  Array of user IDs who have added the story in their favorites

Select a Language

Example Request with lang_code and import_lang

Request

curl "https://mapi.storyblok.com/v1/spaces/233027/stories/314931981/import.json?lang_code=pt-br&import_lang=true" \ 
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -d "{story: {\"name\": \"Home\",\"parent_id\": 0,\"group_id\": \"fb33b858-277f-4690-81fb-e0a080bd39ac\",\"alternates\": [],\"created_at\": \"2023-05-29T09:53:40.231Z\",\"deleted_at\": null,\"sort_by_date\": null,\"tag_list\": [],\"updated_at\": \"2024-02-08T11:26:42.514Z\",\"published_at\": \"2023-08-30T09:16:42.066Z\",\"id\": 314931981,\"uuid\": \"2497c493-168a-443f-bbb1-ccfd6340d319\",\"is_folder\": false,\"content\": {\"_uid\": \"98cccd01-f807-4494-996d-c6b0de2045a5\",\"component\": \"your_content_type\"// and fields you define yourself are in here},\"published\": true,\"slug\": \"home\",\"path\": null,\"full_slug\": \"home\",\"default_root\": null,\"disble_fe_editor\": false,\"parent\": null,\"is_startpage\": false,\"unpublished_changes\": true,\"meta_data\": null,\"imported_at\": \"2024-02-08T11:26:42.505Z\",\"preview_token\": {token: \"279395174a25be38b702f9ec90d08a960e1a5a84\",timestamp: \"1545530576\"},\"pinned\": false,\"breadcrumbs\": [],\"publish_at\": null,\"expire_at\": null,\"first_published_at\": \"2023-06-06T08:47:05.426Z\",\"last_author\": {\"id\": 39821,\"userid\": \"storyblok\",\"friendly_name\": \"Storyblok\"},\"user_ids\": [12345],\"space_role_ids\": [],\"translated_slugs\": [{}],\"localized_paths\": [{}],\"position\": 0,\"translated_stories\": [],\"can_not_view\": null,\"is_scheduled\": null,\"scheduled_dates\": null,\"favourite_for_user_ids\": []}}"

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('/spaces/233027/stories/314931981/import.json', {
  story: {
    "name": "Home",
    "parent_id": 0,
    "group_id": "fb33b858-277f-4690-81fb-e0a080bd39ac",
    "alternates": [],
    "created_at": "2023-05-29T09:53:40.231Z",
    "deleted_at": null,
    "sort_by_date": null,
    "tag_list": [],
    "updated_at": "2024-02-08T11:26:42.514Z",
    "published_at": "2023-08-30T09:16:42.066Z",
    "id": 314931981,
    "uuid": "2497c493-168a-443f-bbb1-ccfd6340d319",
    "is_folder": false,
    "content": {
      "_uid": "98cccd01-f807-4494-996d-c6b0de2045a5",
      "component": "your_content_type"
      // and fields you define yourself are in here
    },
    "published": true,
    "slug": "home",
    "path": null,
    "full_slug": "home",
    "default_root": null,
    "disble_fe_editor": false,
    "parent": null,
    "is_startpage": false,
    "unpublished_changes": true,
    "meta_data": null,
    "imported_at": "2024-02-08T11:26:42.505Z",
    "preview_token": {
      token: "279395174a25be38b702f9ec90d08a960e1a5a84",
      timestamp: "1545530576"
    },
    "pinned": false,
    "breadcrumbs": [],
    "publish_at": null,
    "expire_at": null,
    "first_published_at": "2023-06-06T08:47:05.426Z",
    "last_author": {
      "id": 39821,
      "userid": "storyblok",
      "friendly_name": "Storyblok"
    },
    "user_ids": [
      12345
    ],
    "space_role_ids": [],
    "translated_slugs": [{}],
    "localized_paths": [{}],
    "position": 0,
    "translated_stories": [],
    "can_not_view": null,
    "is_scheduled": null,
    "scheduled_dates": null,
    "favourite_for_user_ids": []
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

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

$payload = [
  story =>  [
    "name" =>  "Home",
    "parent_id" =>  0,
    "group_id" =>  "fb33b858-277f-4690-81fb-e0a080bd39ac",
    "alternates" =>  [],
    "created_at" =>  "2023-05-29T09 => 53 => 40.231Z",
    "deleted_at" =>  null,
    "sort_by_date" =>  null,
    "tag_list" =>  [],
    "updated_at" =>  "2024-02-08T11 => 26 => 42.514Z",
    "published_at" =>  "2023-08-30T09 => 16 => 42.066Z",
    "id" =>  314931981,
    "uuid" =>  "2497c493-168a-443f-bbb1-ccfd6340d319",
    "is_folder" =>  false,
    "content" =>  [
      "_uid" =>  "98cccd01-f807-4494-996d-c6b0de2045a5",
      "component" =>  "your_content_type"
      // and fields you define yourself are in here
    ],
    "published" =>  true,
    "slug" =>  "home",
    "path" =>  null,
    "full_slug" =>  "home",
    "default_root" =>  null,
    "disble_fe_editor" =>  false,
    "parent" =>  null,
    "is_startpage" =>  false,
    "unpublished_changes" =>  true,
    "meta_data" =>  null,
    "imported_at" =>  "2024-02-08T11 => 26 => 42.505Z",
    "preview_token" =>  [
      token =>  "279395174a25be38b702f9ec90d08a960e1a5a84",
      timestamp =>  "1545530576"
    ],
    "pinned" =>  false,
    "breadcrumbs" =>  [],
    "publish_at" =>  null,
    "expire_at" =>  null,
    "first_published_at" =>  "2023-06-06T08 => 47 => 05.426Z",
    "last_author" =>  [
      "id" =>  39821,
      "userid" =>  "storyblok",
      "friendly_name" =>  "Storyblok"
    ],
    "user_ids" =>  [
      12345
    ],
    "space_role_ids" =>  [],
    "translated_slugs" =>  [[]],
    "localized_paths" =>  [[]],
    "position" =>  0,
    "translated_stories" =>  [],
    "can_not_view" =>  null,
    "is_scheduled" =>  null,
    "scheduled_dates" =>  null,
    "favourite_for_user_ids" =>  []
  ]
];

$client->put('/spaces/233027/stories/314931981/import.json', $payload)->getBody();

Request

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

payload = {
  story =>  {
    "name" =>  "Home",
    "parent_id" =>  0,
    "group_id" =>  "fb33b858-277f-4690-81fb-e0a080bd39ac",
    "alternates" =>  [],
    "created_at" =>  "2023-05-29T09 => 53 => 40.231Z",
    "deleted_at" =>  null,
    "sort_by_date" =>  null,
    "tag_list" =>  [],
    "updated_at" =>  "2024-02-08T11 => 26 => 42.514Z",
    "published_at" =>  "2023-08-30T09 => 16 => 42.066Z",
    "id" =>  314931981,
    "uuid" =>  "2497c493-168a-443f-bbb1-ccfd6340d319",
    "is_folder" =>  false,
    "content" =>  {
      "_uid" =>  "98cccd01-f807-4494-996d-c6b0de2045a5",
      "component" =>  "your_content_type"
      // and fields you define yourself are in here
    },
    "published" =>  true,
    "slug" =>  "home",
    "path" =>  null,
    "full_slug" =>  "home",
    "default_root" =>  null,
    "disble_fe_editor" =>  false,
    "parent" =>  null,
    "is_startpage" =>  false,
    "unpublished_changes" =>  true,
    "meta_data" =>  null,
    "imported_at" =>  "2024-02-08T11 => 26 => 42.505Z",
    "preview_token" =>  {
      token =>  "279395174a25be38b702f9ec90d08a960e1a5a84",
      timestamp =>  "1545530576"
    },
    "pinned" =>  false,
    "breadcrumbs" =>  [],
    "publish_at" =>  null,
    "expire_at" =>  null,
    "first_published_at" =>  "2023-06-06T08 => 47 => 05.426Z",
    "last_author" =>  {
      "id" =>  39821,
      "userid" =>  "storyblok",
      "friendly_name" =>  "Storyblok"
    },
    "user_ids" =>  [
      12345
    ],
    "space_role_ids" =>  [],
    "translated_slugs" =>  [{}],
    "localized_paths" =>  [{}],
    "position" =>  0,
    "translated_stories" =>  [],
    "can_not_view" =>  null,
    "is_scheduled" =>  null,
    "scheduled_dates" =>  null,
    "favourite_for_user_ids" =>  []
  }
}

client.put('/spaces/233027/stories/314931981/import.json', payload)

Request

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/233027/stories/314931981/import.json?lang_code=pt-br&import_lang=true")
  .header("Content-Type", "multipart/form-data")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{story: {\"name\": \"Home\",\"parent_id\": 0,\"group_id\": \"fb33b858-277f-4690-81fb-e0a080bd39ac\",\"alternates\": [],\"created_at\": \"2023-05-29T09:53:40.231Z\",\"deleted_at\": null,\"sort_by_date\": null,\"tag_list\": [],\"updated_at\": \"2024-02-08T11:26:42.514Z\",\"published_at\": \"2023-08-30T09:16:42.066Z\",\"id\": 314931981,\"uuid\": \"2497c493-168a-443f-bbb1-ccfd6340d319\",\"is_folder\": false,\"content\": {\"_uid\": \"98cccd01-f807-4494-996d-c6b0de2045a5\",\"component\": \"your_content_type\"// and fields you define yourself are in here},\"published\": true,\"slug\": \"home\",\"path\": null,\"full_slug\": \"home\",\"default_root\": null,\"disble_fe_editor\": false,\"parent\": null,\"is_startpage\": false,\"unpublished_changes\": true,\"meta_data\": null,\"imported_at\": \"2024-02-08T11:26:42.505Z\",\"preview_token\": {token: \"279395174a25be38b702f9ec90d08a960e1a5a84\",timestamp: \"1545530576\"},\"pinned\": false,\"breadcrumbs\": [],\"publish_at\": null,\"expire_at\": null,\"first_published_at\": \"2023-06-06T08:47:05.426Z\",\"last_author\": {\"id\": 39821,\"userid\": \"storyblok\",\"friendly_name\": \"Storyblok\"},\"user_ids\": [12345],\"space_role_ids\": [],\"translated_slugs\": [{}],\"localized_paths\": [{}],\"position\": 0,\"translated_stories\": [],\"can_not_view\": null,\"is_scheduled\": null,\"scheduled_dates\": null,\"favourite_for_user_ids\": []}}")
  .asString();

Request

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/233027/stories/314931981/import.json?lang_code=pt-br&import_lang=true");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("multipart/form-data", "{story: {\"name\": \"Home\",\"parent_id\": 0,\"group_id\": \"fb33b858-277f-4690-81fb-e0a080bd39ac\",\"alternates\": [],\"created_at\": \"2023-05-29T09:53:40.231Z\",\"deleted_at\": null,\"sort_by_date\": null,\"tag_list\": [],\"updated_at\": \"2024-02-08T11:26:42.514Z\",\"published_at\": \"2023-08-30T09:16:42.066Z\",\"id\": 314931981,\"uuid\": \"2497c493-168a-443f-bbb1-ccfd6340d319\",\"is_folder\": false,\"content\": {\"_uid\": \"98cccd01-f807-4494-996d-c6b0de2045a5\",\"component\": \"your_content_type\"// and fields you define yourself are in here},\"published\": true,\"slug\": \"home\",\"path\": null,\"full_slug\": \"home\",\"default_root\": null,\"disble_fe_editor\": false,\"parent\": null,\"is_startpage\": false,\"unpublished_changes\": true,\"meta_data\": null,\"imported_at\": \"2024-02-08T11:26:42.505Z\",\"preview_token\": {token: \"279395174a25be38b702f9ec90d08a960e1a5a84\",timestamp: \"1545530576\"},\"pinned\": false,\"breadcrumbs\": [],\"publish_at\": null,\"expire_at\": null,\"first_published_at\": \"2023-06-06T08:47:05.426Z\",\"last_author\": {\"id\": 39821,\"userid\": \"storyblok\",\"friendly_name\": \"Storyblok\"},\"user_ids\": [12345],\"space_role_ids\": [],\"translated_slugs\": [{}],\"localized_paths\": [{}],\"position\": 0,\"translated_stories\": [],\"can_not_view\": null,\"is_scheduled\": null,\"scheduled_dates\": null,\"favourite_for_user_ids\": []}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request

import Foundation

let headers = [
  "Content-Type": "multipart/form-data",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{story: {\"name\": \"Home\",\"parent_id\": 0,\"group_id\": \"fb33b858-277f-4690-81fb-e0a080bd39ac\",\"alternates\": [],\"created_at\": \"2023-05-29T09:53:40.231Z\",\"deleted_at\": null,\"sort_by_date\": null,\"tag_list\": [],\"updated_at\": \"2024-02-08T11:26:42.514Z\",\"published_at\": \"2023-08-30T09:16:42.066Z\",\"id\": 314931981,\"uuid\": \"2497c493-168a-443f-bbb1-ccfd6340d319\",\"is_folder\": false,\"content\": {\"_uid\": \"98cccd01-f807-4494-996d-c6b0de2045a5\",\"component\": \"your_content_type\"// and fields you define yourself are in here},\"published\": true,\"slug\": \"home\",\"path\": null,\"full_slug\": \"home\",\"default_root\": null,\"disble_fe_editor\": false,\"parent\": null,\"is_startpage\": false,\"unpublished_changes\": true,\"meta_data\": null,\"imported_at\": \"2024-02-08T11:26:42.505Z\",\"preview_token\": {token: \"279395174a25be38b702f9ec90d08a960e1a5a84\",timestamp: \"1545530576\"},\"pinned\": false,\"breadcrumbs\": [],\"publish_at\": null,\"expire_at\": null,\"first_published_at\": \"2023-06-06T08:47:05.426Z\",\"last_author\": {\"id\": 39821,\"userid\": \"storyblok\",\"friendly_name\": \"Storyblok\"},\"user_ids\": [12345],\"space_role_ids\": [],\"translated_slugs\": [{}],\"localized_paths\": [{}],\"position\": 0,\"translated_stories\": [],\"can_not_view\": null,\"is_scheduled\": null,\"scheduled_dates\": null,\"favourite_for_user_ids\": []}}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/233027/stories/314931981/import.json?lang_code=pt-br&import_lang=true")! 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/spaces/233027/stories/314931981/import.json"

querystring = {"lang_code":"pt-br","import_lang":"true"}

payload = "{story: {\"name\": \"Home\",\"parent_id\": 0,\"group_id\": \"fb33b858-277f-4690-81fb-e0a080bd39ac\",\"alternates\": [],\"created_at\": \"2023-05-29T09:53:40.231Z\",\"deleted_at\": null,\"sort_by_date\": null,\"tag_list\": [],\"updated_at\": \"2024-02-08T11:26:42.514Z\",\"published_at\": \"2023-08-30T09:16:42.066Z\",\"id\": 314931981,\"uuid\": \"2497c493-168a-443f-bbb1-ccfd6340d319\",\"is_folder\": false,\"content\": {\"_uid\": \"98cccd01-f807-4494-996d-c6b0de2045a5\",\"component\": \"your_content_type\"// and fields you define yourself are in here},\"published\": true,\"slug\": \"home\",\"path\": null,\"full_slug\": \"home\",\"default_root\": null,\"disble_fe_editor\": false,\"parent\": null,\"is_startpage\": false,\"unpublished_changes\": true,\"meta_data\": null,\"imported_at\": \"2024-02-08T11:26:42.505Z\",\"preview_token\": {token: \"279395174a25be38b702f9ec90d08a960e1a5a84\",timestamp: \"1545530576\"},\"pinned\": false,\"breadcrumbs\": [],\"publish_at\": null,\"expire_at\": null,\"first_published_at\": \"2023-06-06T08:47:05.426Z\",\"last_author\": {\"id\": 39821,\"userid\": \"storyblok\",\"friendly_name\": \"Storyblok\"},\"user_ids\": [12345],\"space_role_ids\": [],\"translated_slugs\": [{}],\"localized_paths\": [{}],\"position\": 0,\"translated_stories\": [],\"can_not_view\": null,\"is_scheduled\": null,\"scheduled_dates\": null,\"favourite_for_user_ids\": []}}"
headers = {
  'Content-Type': "multipart/form-data",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)

print(response.text)

Prev Export a Story

Next Introduction