Import a Story

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

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

Caution

Importing stories is available exclusively on higher-tier plans. 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

• version string

  Default: 1. Possible value: 1, 2.

• 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

Response properties

• story The Story Object

  A single story object

Examples

Example Request with lang_code and import_lang

cURL

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

JS client

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

PHP client

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

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

$client->put('spaces/233027/stories/314931981/import.json?lang_code=pt-br&import_lang=true', $payload)->getBody();

Java

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

C#

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

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/233027/stories/314931981/import.json"

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

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

client.put('spaces/233027/stories/314931981/import.json', {:params => {
  "lang_code" => "pt-br",
  "import_lang" => "true"
}}, payload)

Swift

import Foundation

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

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

When using the import endpoint with version 2 data, stories no longer need to be stringified. Simply use the exported stories from v2 as-is to ensure compatibility with the updated structure.