Create a Branch

POST

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

This endpoint creates a new branch.

Path parameters

• :space_id required number

  Numeric ID of a space

Request body properties

• branch The Branch Object

  A branch object

Response properties

• branch The Branch Object

  A branch object

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/branches/" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"branch\":{\"name\":\"A new branch\",\"position\":2,\"source_id\":12332,\"url\":\"https://new_domain.com\"}}"

JS

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('spaces/288868932106293/branches/', {
  "branch": {
    "name": "A new branch",
    "position": 2,
    "source_id": 12332,
    "url": "https://new_domain.com"
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP

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

$payload = ["branch" => ["name" => "A new branch","position" => 2,"source_id" => 12332,"url" => "https => //new_domain.com"]];

$client->post('spaces/288868932106293/branches/', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/288868932106293/branches/")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"branch":{"name":"A new branch","position":2,"source_id":12332,"url":"https://new_domain.com"}})
  .asString();

C#

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

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"branch\":{\"name\":\"A new branch\",\"position\":2,\"source_id\":12332,\"url\":\"https://new_domain.com\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/288868932106293/branches/"

querystring = {}

payload = {"branch":{"name":"A new branch","position":2,"source_id":12332,"url":"https://new_domain.com"}}
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 = {"branch" => {"name" => "A new branch","position" => 2,"source_id" => 12332,"url" => "https => //new_domain.com"}}

client.post('spaces/288868932106293/branches/', payload)

Swift

var request = URLRequest(url: URL(string: "https://mapi.storyblok.com/v1/spaces/288868932106293/branches/")!)
request.setValue("YOUR_OAUTH_TOKEN", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "branch": [
        "name": "A new branch",
        "position": 2,
        "source_id": 12332,
        "url": "https://new_domain.com",
    ],
])
let (data, _) = try await URLSession.shared.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(ContentNegotiation) { json() }
    install(DefaultRequest) {
        url {
            takeFrom("https://mapi.storyblok.com/v1/")
            headers.append("Authorization", "YOUR_OAUTH_TOKEN")
        }
    }
}

val response = client.post("spaces/288868932106293/branches/") {
    contentType(ContentType.Application.Json)
    setBody(buildJsonObject {
        putJsonObject("branch") {
            put("name", "A new branch")
            put("position", 2)
            put("source_id", 12332)
            put("url", "https://new_domain.com")
        }
    })
}

println(response.body<JsonElement>())

You will receive a branch object as a response.